diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 5d408b8..13fc742 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -22,7 +22,7 @@ jobs: - name: Install latest nightly uses: actions-rs/toolchain@v1 with: - toolchain: stable + toolchain: nightly override: true components: rustfmt, clippy diff --git a/.gitignore b/.gitignore index ab1c6ae..a864a07 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,7 @@ target Cargo.lock driver tarpaulin-report.html +/.idea/ +/playwright-rust-randall.iml +/scripts/scripts.iml +/src/api/generated.rs diff --git a/Cargo.toml b/Cargo.toml index cff97a3..e1d9305 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -8,7 +8,7 @@ documentation = "https://docs.rs/playwright/" repository = "https://github.com/octaltree/playwright-rust" categories = ["web-programming"] keywords = ["testing", "headless", "web", "browser", "automation"] -edition = "2018" +edition = "2021" build = "src/build.rs" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html @@ -20,23 +20,24 @@ reqwest = { version = "0.11.4", features = ["blocking"] } log = "0.4.14" serde = { version = "1.0.126", features = ["derive"] } serde_json = "1.0.66" -zip = "0.5.13" +zip = "0.6.4" thiserror = "1.0.26" strong = { version = "0.3.4", features = ["serde", "shorthand"] } tokio = { version = "1.9.0", features = ["sync", "rt-multi-thread", "macros"] } actix-rt = { version = "2.2.0", optional = true } async-std = { version = "1.9.0", features = ["attributes"], optional = true } -dirs = "3.0.2" +dirs = "5.0.0" paste = "1.0.5" -base64 = "0.13.0" +base64 = "0.21.0" itertools = "0.10.1" chrono = { version = "0.4.19", optional = true, features = ["serde"] } tokio-stream = { version = "0.1.7", features = ["sync"] } futures = "0.3.16" -serde_with = { version = "1.9.4", default-features = false, features = ["macros"] } +serde_with = { version = "2.3.2", default-features = false, features = ["macros"] } +parking_lot = "0.12.1" [dev-dependencies] -env_logger = "0.9.0" +env_logger = "0.10.0" tempdir = "0.3.7" tide = "0.16.0" warp = "0.3.1" diff --git a/scripts/src/api.rs b/scripts/src/api.rs index 13e43f0..94b57cd 100644 --- a/scripts/src/api.rs +++ b/scripts/src/api.rs @@ -1,6 +1,6 @@ pub mod types; -use serde::{Deserialize, Serialize}; +use serde::{Deserialize, Deserializer, Serialize}; #[derive(Debug, Deserialize)] #[serde(transparent)] @@ -35,12 +35,26 @@ pub struct Member { pub ty: Type, // langs // paramOrOption null + #[serde(default)] + #[serde(deserialize_with = "string_as_bool")] pub deprecated: bool, //#[serde(default)] // pub comment: String, pub spec: Vec } +fn string_as_bool<'de, D>(deserializer: D) -> Result + where + D: Deserializer<'de>, +{ + let s = ::deserialize(deserializer); + Ok(match s { + Err(_) => false, + _ => true + }) +} + + #[derive(Debug, Deserialize, PartialEq, Eq, Clone, Copy)] #[serde(rename_all = "camelCase")] pub enum Kind { @@ -79,6 +93,8 @@ pub struct Arg { #[serde(default)] pub spec: Vec, pub required: bool, + #[serde(default)] + #[serde(deserialize_with = "string_as_bool")] pub deprecated: bool, #[serde(rename = "async")] pub is_async: bool diff --git a/scripts/src/api/types.rs b/scripts/src/api/types.rs index 341f555..33e2f4d 100644 --- a/scripts/src/api/types.rs +++ b/scripts/src/api/types.rs @@ -341,15 +341,17 @@ fn declare_ty<'a>(scope: Vec<&'a str>, ty: &'a Type, allow_borrow: bool) -> Rc { + let option = ty.expression.as_deref(); assert!( - ty.expression.as_deref() + option == Some("[IReadOnlyDictionary]") - || ty.expression.as_deref() == Some("[Map]<[string], [JSHandle]>") - || ty.expression.as_deref() == Some("[Object]<[string], [string]>") - || ty.expression.as_deref() + || option == Some("[Map]<[string], [JSHandle]>") + || option == Some("[Map]") + || option == Some("[Object]<[string], [string]>") + || option == Some("[Object]<[string], [string]|[float]|[boolean]>") - || ty.expression.as_deref() == Some("[Object]<[string], [Serializable]>") - || ty.expression.as_deref() == Some("[Object]<[string], [any]>"), + || option == Some("[Object]<[string], [Serializable]>") + || option == Some("[Object]<[string], [any]>"), "{:?}", &ty ); diff --git a/scripts/src/generate_api.rs b/scripts/src/generate_api.rs index 09c1999..a16602b 100644 --- a/scripts/src/generate_api.rs +++ b/scripts/src/generate_api.rs @@ -143,21 +143,24 @@ fn format_use_ty(x: &types::Model) -> TokenStream { let z = format_use_ty(z); quote!(HashMap<#y, #z>) } - Model::Known { name, .. } => match name.as_ref() { - "binary" if reference => quote!(&'a [u8]), - "binary" => quote!(Vec), - "json" if reference => quote!(&'a str), - "json" => quote!(String), - "string" if reference => quote!(&'a str), - "string" => quote!(String), - "number" => quote!(serde_json::Number), - "float" => quote!(f64), - "boolean" => quote!(bool), - "void" => quote!(()), - _ => { - let n = format_ident!("{}", name); - assert!(!reference); - quote!(#n) + Model::Known { name, .. } => { + match name.as_ref() { + "binary" if reference => quote!(&'a [u8]), + "binary" => quote!(Vec), + "json" if reference => quote!(&'a str), + "json" => quote!(String), + "string" if reference => quote!(&'a str), + "string" => quote!(String), + "number" => quote!(serde_json::Number), + "float" => quote!(f64), + "boolean" => quote!(bool), + "void" => quote!(()), + "JsonElement?" => quote!(()), + _ => { + let n = format_ident!("{}", name); + assert!(!reference); + quote!(#n) + } } } } diff --git a/scripts/src/generate_protocol.rs b/scripts/src/generate_protocol.rs index c480091..960bb40 100644 --- a/scripts/src/generate_protocol.rs +++ b/scripts/src/generate_protocol.rs @@ -59,7 +59,7 @@ fn enum_tokens(name: &str, x: &Enum) -> TokenStream { .collect::>(); let name = format_ident!("{}", name); quote! { - #[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone)] + #[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone, Hash)] pub enum #name { #(#variants),* } diff --git a/src/api/api.json b/src/api/api.json index 567df5b..4c44388 100644 --- a/src/api/api.json +++ b/src/api/api.json @@ -4,19 +4,19 @@ "spec": [ { "type": "text", - "text": "The Accessibility class provides methods for inspecting Chromium's accessibility tree. The accessibility tree is used by assistive technology such as [screen readers](https://en.wikipedia.org/wiki/Screen_reader) or [switches](https://en.wikipedia.org/wiki/Switch_access)." + "text": "The Accessibility class provides methods for inspecting Chromium's accessibility tree. The accessibility tree is used by↵assistive technology such as [screen readers](https://en.wikipedia.org/wiki/Screen_reader) or↵[switches](https://en.wikipedia.org/wiki/Switch_access)." }, { "type": "text", - "text": "Accessibility is a very platform-specific thing. On different platforms, there are different screen readers that might have wildly different output." + "text": "Accessibility is a very platform-specific thing. On different platforms, there are different screen readers that might↵have wildly different output." }, { "type": "text", - "text": "Rendering engines of Chromium, Firefox and WebKit have a concept of \"accessibility tree\", which is then translated into different platform-specific APIs. Accessibility namespace gives access to this Accessibility Tree." + "text": "Rendering engines of Chromium, Firefox and WebKit have a concept of \"accessibility tree\", which is then translated into different↵platform-specific APIs. Accessibility namespace gives access to this Accessibility Tree." }, { "type": "text", - "text": "Most of the accessibility tree gets filtered out when converting from internal browser AX Tree to Platform-specific AX-Tree or by assistive technologies themselves. By default, Playwright tries to approximate this filtering, exposing only the \"interesting\" nodes of the tree." + "text": "Most of the accessibility tree gets filtered out when converting from internal browser AX Tree to Platform-specific AX-Tree or by↵assistive technologies themselves. By default, Playwright tries to approximate this filtering, exposing only the↵\"interesting\" nodes of the tree." } ], "langs": { @@ -29,7 +29,8 @@ "types": {}, "overrides": {} }, - "comment": "The Accessibility class provides methods for inspecting Chromium's accessibility tree. The accessibility tree is used by\nassistive technology such as [screen readers](https://en.wikipedia.org/wiki/Screen_reader) or\n[switches](https://en.wikipedia.org/wiki/Switch_access).\n\nAccessibility is a very platform-specific thing. On different platforms, there are different screen readers that might\nhave wildly different output.\n\nRendering engines of Chromium, Firefox and WebKit have a concept of \"accessibility tree\", which is then translated into\ndifferent platform-specific APIs. Accessibility namespace gives access to this Accessibility Tree.\n\nMost of the accessibility tree gets filtered out when converting from internal browser AX Tree to Platform-specific\nAX-Tree or by assistive technologies themselves. By default, Playwright tries to approximate this filtering, exposing\nonly the \"interesting\" nodes of the tree.", + "comment": "The Accessibility class provides methods for inspecting Chromium's accessibility tree. The accessibility tree is\nused by assistive technology such as [screen readers](https://en.wikipedia.org/wiki/Screen_reader) or\n[switches](https://en.wikipedia.org/wiki/Switch_access).\n\nAccessibility is a very platform-specific thing. On different platforms, there are different screen readers that\nmight have wildly different output.\n\nRendering engines of Chromium, Firefox and WebKit have a concept of \"accessibility tree\", which is then translated\ninto different platform-specific APIs. Accessibility namespace gives access to this Accessibility Tree.\n\nMost of the accessibility tree gets filtered out when converting from internal browser AX Tree to Platform-specific\nAX-Tree or by assistive technologies themselves. By default, Playwright tries to approximate this filtering,\nexposing only the \"interesting\" nodes of the tree.", + "since": "v1.8", "members": [ { "kind": "method", @@ -63,6 +64,7 @@ }, "experimental": false, "since": "v1.8", + "deprecated": "This method is deprecated. Please use other libraries such as [Axe](https://www.deque.com/axe/) if you need to test page accessibility. See our Node.js [guide](https://playwright.dev/docs/accessibility-testing) for integration with Axe.", "name": "snapshot", "type": { "name": "", @@ -91,7 +93,6 @@ ], "required": true, "comment": "The [role](https://www.w3.org/TR/wai-aria/#usage_intro).", - "deprecated": false, "async": false, "alias": "role", "overloadIndex": 0, @@ -115,7 +116,6 @@ ], "required": true, "comment": "A human readable name for the node.", - "deprecated": false, "async": false, "alias": "name", "overloadIndex": 0, @@ -147,7 +147,6 @@ ], "required": true, "comment": "The current value of the node, if applicable.", - "deprecated": false, "async": false, "alias": "value", "overloadIndex": 0, @@ -171,7 +170,6 @@ ], "required": true, "comment": "An additional human readable description of the node, if applicable.", - "deprecated": false, "async": false, "alias": "description", "overloadIndex": 0, @@ -195,7 +193,6 @@ ], "required": true, "comment": "Keyboard shortcuts associated with this node, if applicable.", - "deprecated": false, "async": false, "alias": "keyshortcuts", "overloadIndex": 0, @@ -219,7 +216,6 @@ ], "required": true, "comment": "A human readable alternative to the role, if applicable.", - "deprecated": false, "async": false, "alias": "roledescription", "overloadIndex": 0, @@ -243,7 +239,6 @@ ], "required": true, "comment": "A description of the current value, if applicable.", - "deprecated": false, "async": false, "alias": "valuetext", "overloadIndex": 0, @@ -267,7 +262,6 @@ ], "required": true, "comment": "Whether the node is disabled, if applicable.", - "deprecated": false, "async": false, "alias": "disabled", "overloadIndex": 0, @@ -291,7 +285,6 @@ ], "required": true, "comment": "Whether the node is expanded or collapsed, if applicable.", - "deprecated": false, "async": false, "alias": "expanded", "overloadIndex": 0, @@ -315,7 +308,6 @@ ], "required": true, "comment": "Whether the node is focused, if applicable.", - "deprecated": false, "async": false, "alias": "focused", "overloadIndex": 0, @@ -339,7 +331,6 @@ ], "required": true, "comment": "Whether the node is [modal](https://en.wikipedia.org/wiki/Modal_window), if applicable.", - "deprecated": false, "async": false, "alias": "modal", "overloadIndex": 0, @@ -363,7 +354,6 @@ ], "required": true, "comment": "Whether the node text input supports multiline, if applicable.", - "deprecated": false, "async": false, "alias": "multiline", "overloadIndex": 0, @@ -387,7 +377,6 @@ ], "required": true, "comment": "Whether more than one child can be selected, if applicable.", - "deprecated": false, "async": false, "alias": "multiselectable", "overloadIndex": 0, @@ -411,7 +400,6 @@ ], "required": true, "comment": "Whether the node is read only, if applicable.", - "deprecated": false, "async": false, "alias": "readonly", "overloadIndex": 0, @@ -435,7 +423,6 @@ ], "required": true, "comment": "Whether the node is required, if applicable.", - "deprecated": false, "async": false, "alias": "required", "overloadIndex": 0, @@ -459,7 +446,6 @@ ], "required": true, "comment": "Whether the node is selected in its parent node, if applicable.", - "deprecated": false, "async": false, "alias": "selected", "overloadIndex": 0, @@ -491,7 +477,6 @@ ], "required": true, "comment": "Whether the checkbox is checked, or \"mixed\", if applicable.", - "deprecated": false, "async": false, "alias": "checked", "overloadIndex": 0, @@ -523,7 +508,6 @@ ], "required": true, "comment": "Whether the toggle button is checked, or \"mixed\", if applicable.", - "deprecated": false, "async": false, "alias": "pressed", "overloadIndex": 0, @@ -547,7 +531,6 @@ ], "required": true, "comment": "The level of a heading, if applicable.", - "deprecated": false, "async": false, "alias": "level", "overloadIndex": 0, @@ -571,7 +554,6 @@ ], "required": true, "comment": "The minimum value in a node, if applicable.", - "deprecated": false, "async": false, "alias": "valuemin", "overloadIndex": 0, @@ -595,7 +577,6 @@ ], "required": true, "comment": "The maximum value in a node, if applicable.", - "deprecated": false, "async": false, "alias": "valuemax", "overloadIndex": 0, @@ -619,7 +600,6 @@ ], "required": true, "comment": "What kind of autocomplete is supported by a control, if applicable.", - "deprecated": false, "async": false, "alias": "autocomplete", "overloadIndex": 0, @@ -643,7 +623,6 @@ ], "required": true, "comment": "What kind of popup is currently being shown for a node, if applicable.", - "deprecated": false, "async": false, "alias": "haspopup", "overloadIndex": 0, @@ -667,7 +646,6 @@ ], "required": true, "comment": "Whether and in what way this node's value is invalid, if applicable.", - "deprecated": false, "async": false, "alias": "invalid", "overloadIndex": 0, @@ -691,7 +669,6 @@ ], "required": true, "comment": "Whether the node is oriented horizontally or vertically, if applicable.", - "deprecated": false, "async": false, "alias": "orientation", "overloadIndex": 0, @@ -720,7 +697,6 @@ ], "required": true, "comment": "Child nodes, if any, if applicable.", - "deprecated": false, "async": false, "alias": "children", "overloadIndex": 0, @@ -734,12 +710,16 @@ "spec": [ { "type": "text", - "text": "Captures the current state of the accessibility tree. The returned object represents the root accessible node of the page." + "text": "Captures the current state of the accessibility tree. The returned object represents the root accessible node of the↵page." }, { "type": "note", "noteType": "note", - "text": "The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers. Playwright will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false`." + "text": "The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers. Playwright↵will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false`." + }, + { + "type": "text", + "text": "**Usage**" }, { "type": "text", @@ -865,8 +845,7 @@ } ], "required": true, - "comment": "Captures the current state of the accessibility tree. The returned object represents the root accessible node of the\npage.\n\n> NOTE: The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers.\nPlaywright will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false`.\n\nAn example of dumping the entire accessibility tree:\n\n```js\nconst snapshot = await page.accessibility.snapshot();\nconsole.log(snapshot);\n```\n\n```java\nString snapshot = page.accessibility().snapshot();\nSystem.out.println(snapshot);\n```\n\n```python async\nsnapshot = await page.accessibility.snapshot()\nprint(snapshot)\n```\n\n```python sync\nsnapshot = page.accessibility.snapshot()\nprint(snapshot)\n```\n\n```csharp\nvar accessibilitySnapshot = await page.Accessibility.SnapshotAsync();\nConsole.WriteLine(System.Text.Json.JsonSerializer.Serialize(accessibilitySnapshot));\n```\n\nAn example of logging the focused node's name:\n\n```js\nconst snapshot = await page.accessibility.snapshot();\nconst node = findFocusedNode(snapshot);\nconsole.log(node && node.name);\n\nfunction findFocusedNode(node) {\n if (node.focused)\n return node;\n for (const child of node.children || []) {\n const foundNode = findFocusedNode(child);\n if (foundNode)\n return foundNode;\n }\n return null;\n}\n```\n\n```csharp\nvar accessibilitySnapshot = await page.Accessibility.SnapshotAsync();\nConsole.WriteLine(System.Text.Json.JsonSerializer.Serialize(accessibilitySnapshot));\n```\n\n```java\n// FIXME\nString snapshot = page.accessibility().snapshot();\n```\n\n```python async\ndef find_focused_node(node):\n if (node.get(\"focused\"))\n return node\n for child in (node.get(\"children\") or []):\n found_node = find_focused_node(child)\n if (found_node)\n return found_node\n return None\n\nsnapshot = await page.accessibility.snapshot()\nnode = find_focused_node(snapshot)\nif node:\n print(node[\"name\"])\n```\n\n```python sync\ndef find_focused_node(node):\n if (node.get(\"focused\"))\n return node\n for child in (node.get(\"children\") or []):\n found_node = find_focused_node(child)\n if (found_node)\n return found_node\n return None\n\nsnapshot = page.accessibility.snapshot()\nnode = find_focused_node(snapshot)\nif node:\n print(node[\"name\"])\n```\n", - "deprecated": false, + "comment": "Captures the current state of the accessibility tree. The returned object represents the root accessible node of\nthe page.\n\n**NOTE** The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen\nreaders. Playwright will discard them as well for an easier to process tree, unless `interestingOnly` is set to\n`false`.\n\n**Usage**\n\nAn example of dumping the entire accessibility tree:\n\n```js\nconst snapshot = await page.accessibility.snapshot();\nconsole.log(snapshot);\n```\n\n```java\nString snapshot = page.accessibility().snapshot();\nSystem.out.println(snapshot);\n```\n\n```py\nsnapshot = await page.accessibility.snapshot()\nprint(snapshot)\n```\n\n```py\nsnapshot = page.accessibility.snapshot()\nprint(snapshot)\n```\n\n```csharp\nvar accessibilitySnapshot = await page.Accessibility.SnapshotAsync();\nConsole.WriteLine(System.Text.Json.JsonSerializer.Serialize(accessibilitySnapshot));\n```\n\nAn example of logging the focused node's name:\n\n```js\nconst snapshot = await page.accessibility.snapshot();\nconst node = findFocusedNode(snapshot);\nconsole.log(node && node.name);\n\nfunction findFocusedNode(node) {\n if (node.focused)\n return node;\n for (const child of node.children || []) {\n const foundNode = findFocusedNode(child);\n if (foundNode)\n return foundNode;\n }\n return null;\n}\n```\n\n```csharp\nvar accessibilitySnapshot = await page.Accessibility.SnapshotAsync();\nConsole.WriteLine(System.Text.Json.JsonSerializer.Serialize(accessibilitySnapshot));\n```\n\n```java\n// FIXME\nString snapshot = page.accessibility().snapshot();\n```\n\n```py\ndef find_focused_node(node):\n if (node.get(\"focused\"))\n return node\n for child in (node.get(\"children\") or []):\n found_node = find_focused_node(child)\n if (found_node)\n return found_node\n return None\n\nsnapshot = await page.accessibility.snapshot()\nnode = find_focused_node(snapshot)\nif node:\n print(node[\"name\"])\n```\n\n```py\ndef find_focused_node(node):\n if (node.get(\"focused\"))\n return node\n for child in (node.get(\"children\") or []):\n found_node = find_focused_node(child)\n if (found_node)\n return found_node\n return None\n\nsnapshot = page.accessibility.snapshot()\nnode = find_focused_node(snapshot)\nif node:\n print(node[\"name\"])\n```\n", "async": true, "alias": "snapshot", "overloadIndex": 0, @@ -899,7 +878,6 @@ ], "required": false, "comment": "Prune uninteresting nodes from the tree. Defaults to `true`.", - "deprecated": false, "async": false, "alias": "interestingOnly", "overloadIndex": 0, @@ -923,7 +901,6 @@ ], "required": false, "comment": "The root DOM element for the snapshot. Defaults to the whole page.", - "deprecated": false, "async": false, "alias": "root", "overloadIndex": 0, @@ -933,7 +910,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -1075,8 +1051,152 @@ "types": {}, "overrides": {} }, - "comment": "Playwright has **experimental** support for Android automation. This includes Chrome for Android and Android WebView.\n\n*Requirements*\n- Android device or AVD Emulator.\n- [ADB daemon](https://developer.android.com/studio/command-line/adb) running and authenticated with your device.\n Typically running `adb devices` is all you need to do.\n- [`Chrome 87`](https://play.google.com/store/apps/details?id=com.android.chrome) or newer installed on the device\n- \"Enable command line on non-rooted devices\" enabled in `chrome://flags`.\n\n*Known limitations*\n- Raw USB operation is not yet supported, so you need ADB.\n- Device needs to be awake to produce screenshots. Enabling \"Stay awake\" developer mode will help.\n- We didn't run all the tests against the device, so not everything works.\n\n*How to run*\n\nAn example of the Android automation script would be:\n\n```js\nconst { _android: android } = require('playwright');\n\n(async () => {\n // Connect to the device.\n const [device] = await android.devices();\n console.log(`Model: ${device.model()}`);\n console.log(`Serial: ${device.serial()}`);\n // Take screenshot of the whole device.\n await device.screenshot({ path: 'device.png' });\n\n {\n // --------------------- WebView -----------------------\n\n // Launch an application with WebView.\n await device.shell('am force-stop org.chromium.webview_shell');\n await device.shell('am start org.chromium.webview_shell/.WebViewBrowserActivity');\n // Get the WebView.\n const webview = await device.webView({ pkg: 'org.chromium.webview_shell' });\n\n // Fill the input box.\n await device.fill({ res: 'org.chromium.webview_shell:id/url_field' }, 'github.com/microsoft/playwright');\n await device.press({ res: 'org.chromium.webview_shell:id/url_field' }, 'Enter');\n\n // Work with WebView's page as usual.\n const page = await webview.page();\n await page.waitForNavigation({ url: /.*microsoft\\/playwright.*/ });\n console.log(await page.title());\n }\n\n {\n // --------------------- Browser -----------------------\n\n // Launch Chrome browser.\n await device.shell('am force-stop com.android.chrome');\n const context = await device.launchBrowser();\n\n // Use BrowserContext as usual.\n const page = await context.newPage();\n await page.goto('https://webkit.org/');\n console.log(await page.evaluate(() => window.location.href));\n await page.screenshot({ path: 'page.png' });\n\n await context.close();\n }\n\n // Close the device.\n await device.close();\n})();\n```\n\nNote that since you don't need Playwright to install web browsers when testing Android, you can omit browser download\nvia setting the following environment variable when installing Playwright:\n\n```bash js\nPLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm i -D playwright\n```\n", + "comment": "Playwright has **experimental** support for Android automation. This includes Chrome for Android and Android\nWebView.\n\n*Requirements*\n- Android device or AVD Emulator.\n- [ADB daemon](https://developer.android.com/studio/command-line/adb) running and authenticated with your device.\n Typically running `adb devices` is all you need to do.\n- [`Chrome 87`](https://play.google.com/store/apps/details?id=com.android.chrome) or newer installed on the\n device\n- \"Enable command line on non-rooted devices\" enabled in `chrome://flags`.\n\n*Known limitations*\n- Raw USB operation is not yet supported, so you need ADB.\n- Device needs to be awake to produce screenshots. Enabling \"Stay awake\" developer mode will help.\n- We didn't run all the tests against the device, so not everything works.\n\n*How to run*\n\nAn example of the Android automation script would be:\n\n```js\nconst { _android: android } = require('playwright');\n\n(async () => {\n // Connect to the device.\n const [device] = await android.devices();\n console.log(`Model: ${device.model()}`);\n console.log(`Serial: ${device.serial()}`);\n // Take screenshot of the whole device.\n await device.screenshot({ path: 'device.png' });\n\n {\n // --------------------- WebView -----------------------\n\n // Launch an application with WebView.\n await device.shell('am force-stop org.chromium.webview_shell');\n await device.shell('am start org.chromium.webview_shell/.WebViewBrowserActivity');\n // Get the WebView.\n const webview = await device.webView({ pkg: 'org.chromium.webview_shell' });\n\n // Fill the input box.\n await device.fill({ res: 'org.chromium.webview_shell:id/url_field' }, 'github.com/microsoft/playwright');\n await device.press({ res: 'org.chromium.webview_shell:id/url_field' }, 'Enter');\n\n // Work with WebView's page as usual.\n const page = await webview.page();\n await page.waitForNavigation({ url: /.*microsoft\\/playwright.*/ });\n console.log(await page.title());\n }\n\n {\n // --------------------- Browser -----------------------\n\n // Launch Chrome browser.\n await device.shell('am force-stop com.android.chrome');\n const context = await device.launchBrowser();\n\n // Use BrowserContext as usual.\n const page = await context.newPage();\n await page.goto('https://webkit.org/');\n console.log(await page.evaluate(() => window.location.href));\n await page.screenshot({ path: 'page.png' });\n\n await context.close();\n }\n\n // Close the device.\n await device.close();\n})();\n```\n\nNote that since you don't need Playwright to install web browsers when testing Android, you can omit browser\ndownload via setting the following environment variable when installing Playwright:\n\n```bash\nPLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm i -D playwright\n```\n", + "since": "v1.9", "members": [ + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.28", + "name": "connect", + "type": { + "name": "AndroidDevice", + "expression": "[AndroidDevice]" + }, + "spec": [ + { + "type": "text", + "text": "This methods attaches Playwright to an existing Android device.↵Use [`method: Android.launchServer`] to launch a new Android server instance." + } + ], + "required": true, + "comment": "This methods attaches Playwright to an existing Android device. Use [`method: Android.launchServer`] to launch a\nnew Android server instance.", + "async": true, + "alias": "connect", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.28", + "name": "wsEndpoint", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "A browser websocket endpoint to connect to." + } + ], + "required": true, + "comment": "A browser websocket endpoint to connect to.", + "async": false, + "alias": "wsEndpoint", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "options", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.28", + "name": "headers", + "type": { + "name": "Object", + "templates": [ + { + "name": "string" + }, + { + "name": "string" + } + ], + "expression": "[Object]<[string], [string]>" + }, + "spec": [ + { + "type": "text", + "text": "Additional HTTP headers to be sent with web socket connect request. Optional." + } + ], + "required": false, + "comment": "Additional HTTP headers to be sent with web socket connect request. Optional.", + "async": false, + "alias": "headers", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.28", + "name": "slowMo", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Slows down Playwright operations by the specified amount of milliseconds. Useful so that you↵can see what is going on. Defaults to `0`." + } + ], + "required": false, + "comment": "Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going\non. Defaults to `0`.", + "async": false, + "alias": "slowMo", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.28", + "name": "timeout", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Maximum time in milliseconds to wait for the connection to be established. Defaults to↵`30000` (30 seconds). Pass `0` to disable timeout." + } + ], + "required": false, + "comment": "Maximum time in milliseconds to wait for the connection to be established. Defaults to `30000` (30 seconds). Pass\n`0` to disable timeout.", + "async": false, + "alias": "timeout", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + "required": false, + "comment": "", + "async": false, + "alias": "options", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, { "kind": "method", "langs": {}, @@ -1100,7 +1220,6 @@ ], "required": true, "comment": "Returns the list of detected Android devices.", - "deprecated": false, "async": true, "alias": "devices", "overloadIndex": 0, @@ -1133,7 +1252,6 @@ ], "required": false, "comment": "Optional host to establish ADB server connection. Default to `127.0.0.1`.", - "deprecated": false, "async": false, "alias": "host", "overloadIndex": 0, @@ -1157,7 +1275,6 @@ ], "required": false, "comment": "Prevents automatic playwright driver installation on attach. Assumes that the drivers have been installed already.", - "deprecated": false, "async": false, "alias": "omitDriverInstall", "overloadIndex": 0, @@ -1181,7 +1298,6 @@ ], "required": false, "comment": "Optional port to establish ADB server connection. Default to `5037`.", - "deprecated": false, "async": false, "alias": "port", "overloadIndex": 0, @@ -1191,7 +1307,250 @@ }, "required": false, "comment": "", - "deprecated": false, + "async": false, + "alias": "options", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.28", + "name": "launchServer", + "type": { + "name": "BrowserServer", + "expression": "[BrowserServer]" + }, + "spec": [ + { + "type": "text", + "text": "Launches Playwright Android server that clients can connect to. See the following example:" + }, + { + "type": "text", + "text": "**Usage**" + }, + { + "type": "text", + "text": "Server Side:" + }, + { + "type": "code", + "lines": [ + "const { _android } = require('playwright');", + "", + "(async () => {", + " const browserServer = await _android.launchServer({", + " // If you have multiple devices connected and want to use a specific one.", + " // deviceSerialNumber: '',", + " });", + " const wsEndpoint = browserServer.wsEndpoint();", + " console.log(wsEndpoint);", + "})();" + ], + "codeLang": "js" + }, + { + "type": "text", + "text": "Client Side:" + }, + { + "type": "code", + "lines": [ + "const { _android } = require('playwright');", + "", + "(async () => {", + " const device = await _android.connect('');", + "", + " console.log(device.model());", + " console.log(device.serial());", + " await device.shell('am force-stop com.android.chrome');", + " const context = await device.launchBrowser();", + "", + " const page = await context.newPage();", + " await page.goto('https://webkit.org/');", + " console.log(await page.evaluate(() => window.location.href));", + " await page.screenshot({ path: 'page-chrome-1.png' });", + "", + " await context.close();", + "})();" + ], + "codeLang": "js" + } + ], + "required": true, + "comment": "Launches Playwright Android server that clients can connect to. See the following example:\n\n**Usage**\n\nServer Side:\n\n```js\nconst { _android } = require('playwright');\n\n(async () => {\n const browserServer = await _android.launchServer({\n // If you have multiple devices connected and want to use a specific one.\n // deviceSerialNumber: '',\n });\n const wsEndpoint = browserServer.wsEndpoint();\n console.log(wsEndpoint);\n})();\n```\n\nClient Side:\n\n```js\nconst { _android } = require('playwright');\n\n(async () => {\n const device = await _android.connect('');\n\n console.log(device.model());\n console.log(device.serial());\n await device.shell('am force-stop com.android.chrome');\n const context = await device.launchBrowser();\n\n const page = await context.newPage();\n await page.goto('https://webkit.org/');\n console.log(await page.evaluate(() => window.location.href));\n await page.screenshot({ path: 'page-chrome-1.png' });\n\n await context.close();\n})();\n```\n", + "async": true, + "alias": "launchServer", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "options", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.28", + "name": "adbHost", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Optional host to establish ADB server connection. Default to `127.0.0.1`." + } + ], + "required": false, + "comment": "Optional host to establish ADB server connection. Default to `127.0.0.1`.", + "async": false, + "alias": "adbHost", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.28", + "name": "adbPort", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "Optional port to establish ADB server connection. Default to `5037`." + } + ], + "required": false, + "comment": "Optional port to establish ADB server connection. Default to `5037`.", + "async": false, + "alias": "adbPort", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.28", + "name": "deviceSerialNumber", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Optional device serial number to launch the browser on. If not specified, it will↵throw if multiple devices are connected." + } + ], + "required": false, + "comment": "Optional device serial number to launch the browser on. If not specified, it will throw if multiple devices are\nconnected.", + "async": false, + "alias": "deviceSerialNumber", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.28", + "name": "omitDriverInstall", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Prevents automatic playwright driver installation on attach. Assumes that the drivers have been installed already." + } + ], + "required": false, + "comment": "Prevents automatic playwright driver installation on attach. Assumes that the drivers have been installed already.", + "async": false, + "alias": "omitDriverInstall", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.28", + "name": "port", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "Port to use for the web socket. Defaults to 0 that picks any available port." + } + ], + "required": false, + "comment": "Port to use for the web socket. Defaults to 0 that picks any available port.", + "async": false, + "alias": "port", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.28", + "name": "wsPath", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Path at which to serve the Android Server. For security, this defaults to an↵unguessable string." + }, + { + "type": "note", + "noteType": "warning", + "text": "Any process or web page (including those running in Playwright) with knowledge↵of the `wsPath` can take control of the OS user. For this reason, you should↵use an unguessable token when using this option." + } + ], + "required": false, + "comment": "Path at which to serve the Android Server. For security, this defaults to an unguessable string.\n\n**NOTE** Any process or web page (including those running in Playwright) with knowledge of the `wsPath` can take\ncontrol of the OS user. For this reason, you should use an unguessable token when using this option.", + "async": false, + "alias": "wsPath", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + "required": false, + "comment": "", "async": false, "alias": "options", "overloadIndex": 0, @@ -1216,7 +1575,6 @@ ], "required": true, "comment": "This setting will change the default maximum time for all the methods accepting `timeout` option.", - "deprecated": false, "async": false, "alias": "setDefaultTimeout", "overloadIndex": 0, @@ -1240,7 +1598,6 @@ ], "required": true, "comment": "Maximum time in milliseconds", - "deprecated": false, "async": false, "alias": "timeout", "overloadIndex": 0, @@ -1267,7 +1624,32 @@ "overrides": {} }, "comment": "`AndroidDevice` represents a connected device, either real hardware or emulated. Devices can be obtained using\n[`method: Android.devices`].", + "since": "v1.9", "members": [ + { + "kind": "event", + "langs": {}, + "experimental": false, + "since": "v1.28", + "name": "close", + "type": { + "name": "AndroidDevice", + "expression": "[AndroidDevice]" + }, + "spec": [ + { + "type": "text", + "text": "Emitted when the device connection gets closed." + } + ], + "required": true, + "comment": "Emitted when the device connection gets closed.", + "async": false, + "alias": "close", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, { "kind": "event", "langs": {}, @@ -1286,7 +1668,6 @@ ], "required": true, "comment": "Emitted when a new WebView instance is detected.", - "deprecated": false, "async": false, "alias": "webView", "overloadIndex": 0, @@ -1310,7 +1691,6 @@ ], "required": true, "comment": "Disconnects from the device.", - "deprecated": false, "async": true, "alias": "close", "overloadIndex": 0, @@ -1334,7 +1714,6 @@ ], "required": true, "comment": "Drags the widget defined by `selector` towards `dest` point.", - "deprecated": false, "async": true, "alias": "drag", "overloadIndex": 0, @@ -1358,7 +1737,6 @@ ], "required": true, "comment": "Selector to drag.", - "deprecated": false, "async": false, "alias": "selector", "overloadIndex": 0, @@ -1391,7 +1769,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "x", "overloadIndex": 0, @@ -1415,7 +1792,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "y", "overloadIndex": 0, @@ -1432,7 +1808,6 @@ ], "required": true, "comment": "Point to drag to.", - "deprecated": false, "async": false, "alias": "dest", "overloadIndex": 0, @@ -1465,7 +1840,6 @@ ], "required": false, "comment": "Optional speed of the drag in pixels per second.", - "deprecated": false, "async": false, "alias": "speed", "overloadIndex": 0, @@ -1491,12 +1865,11 @@ "spec": [ { "type": "text", - "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [`method: AndroidDevice.setDefaultTimeout`] method." + "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by↵using the [`method: AndroidDevice.setDefaultTimeout`] method." } ], "required": false, - "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by\nusing the [`method: AndroidDevice.setDefaultTimeout`] method.", - "deprecated": false, + "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed\nby using the [`method: AndroidDevice.setDefaultTimeout`] method.", "async": false, "alias": "timeout", "overloadIndex": 0, @@ -1506,7 +1879,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -1531,7 +1903,6 @@ ], "required": true, "comment": "Fills the specific `selector` input box with `text`.", - "deprecated": false, "async": true, "alias": "fill", "overloadIndex": 0, @@ -1555,7 +1926,6 @@ ], "required": true, "comment": "Selector to fill.", - "deprecated": false, "async": false, "alias": "selector", "overloadIndex": 0, @@ -1579,7 +1949,6 @@ ], "required": true, "comment": "Text to be filled in the input box.", - "deprecated": false, "async": false, "alias": "text", "overloadIndex": 0, @@ -1614,12 +1983,11 @@ "spec": [ { "type": "text", - "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [`method: AndroidDevice.setDefaultTimeout`] method." + "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by↵using the [`method: AndroidDevice.setDefaultTimeout`] method." } ], "required": false, - "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by\nusing the [`method: AndroidDevice.setDefaultTimeout`] method.", - "deprecated": false, + "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed\nby using the [`method: AndroidDevice.setDefaultTimeout`] method.", "async": false, "alias": "timeout", "overloadIndex": 0, @@ -1629,7 +1997,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -1654,7 +2021,6 @@ ], "required": true, "comment": "Flings the widget defined by `selector` in the specified `direction`.", - "deprecated": false, "async": true, "alias": "fling", "overloadIndex": 0, @@ -1678,7 +2044,6 @@ ], "required": true, "comment": "Selector to fling.", - "deprecated": false, "async": false, "alias": "selector", "overloadIndex": 0, @@ -1716,7 +2081,6 @@ ], "required": true, "comment": "Fling direction.", - "deprecated": false, "async": false, "alias": "direction", "overloadIndex": 0, @@ -1749,7 +2113,6 @@ ], "required": false, "comment": "Optional speed of the fling in pixels per second.", - "deprecated": false, "async": false, "alias": "speed", "overloadIndex": 0, @@ -1775,12 +2138,11 @@ "spec": [ { "type": "text", - "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [`method: AndroidDevice.setDefaultTimeout`] method." + "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by↵using the [`method: AndroidDevice.setDefaultTimeout`] method." } ], "required": false, - "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by\nusing the [`method: AndroidDevice.setDefaultTimeout`] method.", - "deprecated": false, + "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed\nby using the [`method: AndroidDevice.setDefaultTimeout`] method.", "async": false, "alias": "timeout", "overloadIndex": 0, @@ -1790,7 +2152,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -1816,7 +2177,6 @@ ], "required": true, "comment": "Returns information about a widget defined by `selector`.", - "deprecated": false, "async": true, "alias": "info", "overloadIndex": 0, @@ -1840,7 +2200,6 @@ ], "required": true, "comment": "Selector to return information about.", - "deprecated": false, "async": false, "alias": "selector", "overloadIndex": 0, @@ -1861,7 +2220,6 @@ "spec": [], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "input", "overloadIndex": 0, @@ -1885,7 +2243,6 @@ ], "required": true, "comment": "Installs an apk on the device.", - "deprecated": false, "async": true, "alias": "installApk", "overloadIndex": 0, @@ -1917,7 +2274,6 @@ ], "required": true, "comment": "Either a path to the apk file, or apk file content.", - "deprecated": false, "async": false, "alias": "file", "overloadIndex": 0, @@ -1955,7 +2311,6 @@ ], "required": false, "comment": "Optional arguments to pass to the `shell:cmd package install` call. Defaults to `-r -t -S`.", - "deprecated": false, "async": false, "alias": "args", "overloadIndex": 0, @@ -1965,7 +2320,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -1991,7 +2345,6 @@ ], "required": true, "comment": "Launches Chrome browser on the device, and returns its persistent context.", - "deprecated": false, "async": true, "alias": "launchBrowser", "overloadIndex": 0, @@ -2024,12 +2377,39 @@ ], "required": false, "comment": "Whether to automatically download all the attachments. Defaults to `true` where all the downloads are accepted.", - "deprecated": false, "async": false, "alias": "acceptDownloads", "overloadIndex": 0, "paramOrOption": null }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.29", + "name": "args", + "type": { + "name": "Array", + "templates": [ + { + "name": "string" + } + ], + "expression": "[Array]<[string]>" + }, + "spec": [ + { + "type": "text", + "text": "Additional arguments to pass to the browser instance. The list of Chromium flags can be found↵[here](http://peter.sh/experiments/chromium-command-line-switches/)." + } + ], + "required": false, + "comment": "Additional arguments to pass to the browser instance. The list of Chromium flags can be found\n[here](http://peter.sh/experiments/chromium-command-line-switches/).", + "async": false, + "alias": "args", + "overloadIndex": 0, + "paramOrOption": null + }, { "kind": "property", "langs": {}, @@ -2062,8 +2442,7 @@ } ], "required": false, - "comment": "When using [`method: Page.goto`], [`method: Page.route`], [`method: Page.waitForURL`], [`method: Page.waitForRequest`],\nor [`method: Page.waitForResponse`] it takes the base URL in consideration by using the\n[`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the corresponding URL.\nExamples:\n- baseURL: `http://localhost:3000` and navigating to `/bar.html` results in `http://localhost:3000/bar.html`\n- baseURL: `http://localhost:3000/foo/` and navigating to `./bar.html` results in `http://localhost:3000/foo/bar.html`\n- baseURL: `http://localhost:3000/foo` (without trailing slash) and navigating to `./bar.html` results in\n `http://localhost:3000/bar.html`", - "deprecated": false, + "comment": "When using [`method: Page.goto`], [`method: Page.route`], [`method: Page.waitForURL`],\n[`method: Page.waitForRequest`], or [`method: Page.waitForResponse`] it takes the base URL in consideration by\nusing the [`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the\ncorresponding URL. Examples:\n- baseURL: `http://localhost:3000` and navigating to `/bar.html` results in `http://localhost:3000/bar.html`\n- baseURL: `http://localhost:3000/foo/` and navigating to `./bar.html` results in\n `http://localhost:3000/foo/bar.html`\n- baseURL: `http://localhost:3000/foo` (without trailing slash) and navigating to `./bar.html` results in\n `http://localhost:3000/bar.html`", "async": false, "alias": "baseURL", "overloadIndex": 0, @@ -2087,7 +2466,6 @@ ], "required": false, "comment": "Toggles bypassing page's Content-Security-Policy.", - "deprecated": false, "async": false, "alias": "bypassCSP", "overloadIndex": 0, @@ -2095,7 +2473,65 @@ }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "js", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.9", + "name": "colorScheme", + "type": { + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "ColorScheme", + "union": [ + { + "name": "\"light\"" + }, + { + "name": "\"dark\"" + }, + { + "name": "\"no-preference\"" + } + ] + } + ], + "expression": "null|[ColorScheme]<\"light\"|\"dark\"|\"no-preference\">" + }, + "spec": [ + { + "type": "text", + "text": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See↵[`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to `'light'`." + } + ], + "required": false, + "comment": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to\n`'light'`.", + "async": false, + "alias": "colorScheme", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, "since": "v1.9", "name": "colorScheme", @@ -2110,19 +2546,21 @@ }, { "name": "\"no-preference\"" + }, + { + "name": "\"null\"" } ], - "expression": "[ColorScheme]<\"light\"|\"dark\"|\"no-preference\">" + "expression": "[ColorScheme]<\"light\"|\"dark\"|\"no-preference\"|\"null\">" }, "spec": [ { "type": "text", - "text": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See [`method: Page.emulateMedia`] for more details. Defaults to `'light'`." + "text": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See↵[`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to `'light'`." } ], "required": false, - "comment": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Defaults to `'light'`.", - "deprecated": false, + "comment": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to\n`'light'`.", "async": false, "alias": "colorScheme", "overloadIndex": 0, @@ -2146,7 +2584,6 @@ ], "required": false, "comment": "Optional package name to launch instead of default Chrome for Android.", - "deprecated": false, "async": false, "alias": "command", "overloadIndex": 0, @@ -2170,7 +2607,6 @@ ], "required": false, "comment": "Specify device scale factor (can be thought of as dpr). Defaults to `1`.", - "deprecated": false, "async": false, "alias": "deviceScaleFactor", "overloadIndex": 0, @@ -2202,7 +2638,6 @@ ], "required": false, "comment": "An object containing additional HTTP headers to be sent with every request.", - "deprecated": false, "async": false, "alias": "extraHTTPHeaders", "overloadIndex": 0, @@ -2210,7 +2645,62 @@ }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "js", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.9", + "name": "forcedColors", + "type": { + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "ForcedColors", + "union": [ + { + "name": "\"active\"" + }, + { + "name": "\"none\"" + } + ] + } + ], + "expression": "null|[ForcedColors]<\"active\"|\"none\">" + }, + "spec": [ + { + "type": "text", + "text": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See [`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to `'none'`." + } + ], + "required": false, + "comment": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See\n[`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to\n`'none'`.", + "async": false, + "alias": "forcedColors", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, "since": "v1.9", "name": "forcedColors", @@ -2222,24 +2712,21 @@ }, { "name": "\"none\"" + }, + { + "name": "\"null\"" } ], - "expression": "[ForcedColors]<\"active\"|\"none\">" + "expression": "[ForcedColors]<\"active\"|\"none\"|\"null\">" }, "spec": [ { "type": "text", - "text": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See [`method: Page.emulateMedia`] for more details. Defaults to `'none'`." - }, - { - "type": "note", - "noteType": "note", - "text": "It's not supported in WebKit, see [here](https://bugs.webkit.org/show_bug.cgi?id=225281) in their issue tracker." + "text": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See [`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to `'none'`." } ], "required": false, - "comment": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See [`method: Page.emulateMedia`]\nfor more details. Defaults to `'none'`.\n\n> NOTE: It's not supported in WebKit, see [here](https://bugs.webkit.org/show_bug.cgi?id=225281) in their issue tracker.", - "deprecated": false, + "comment": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See\n[`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to\n`'none'`.", "async": false, "alias": "forcedColors", "overloadIndex": 0, @@ -2272,7 +2759,6 @@ ], "required": true, "comment": "Latitude between -90 and 90.", - "deprecated": false, "async": false, "alias": "latitude", "overloadIndex": 0, @@ -2296,7 +2782,6 @@ ], "required": true, "comment": "Longitude between -180 and 180.", - "deprecated": false, "async": false, "alias": "longitude", "overloadIndex": 0, @@ -2320,7 +2805,6 @@ ], "required": false, "comment": "Non-negative accuracy value. Defaults to `0`.", - "deprecated": false, "async": false, "alias": "accuracy", "overloadIndex": 0, @@ -2332,7 +2816,6 @@ "spec": [], "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "geolocation", "overloadIndex": 0, @@ -2356,7 +2839,6 @@ ], "required": false, "comment": "Specifies if viewport supports touch events. Defaults to false.", - "deprecated": false, "async": false, "alias": "hasTouch", "overloadIndex": 0, @@ -2389,7 +2871,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "username", "overloadIndex": 0, @@ -2413,7 +2894,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "password", "overloadIndex": 0, @@ -2430,7 +2910,6 @@ ], "required": false, "comment": "Credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication).", - "deprecated": false, "async": false, "alias": "httpCredentials", "overloadIndex": 0, @@ -2454,7 +2933,6 @@ ], "required": false, "comment": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.", - "deprecated": false, "async": false, "alias": "ignoreHTTPSErrors", "overloadIndex": 0, @@ -2473,12 +2951,11 @@ "spec": [ { "type": "text", - "text": "Whether the `meta viewport` tag is taken into account and touch events are enabled. Defaults to `false`. Not supported in Firefox." + "text": "Whether the `meta viewport` tag is taken into account and touch events are enabled. Defaults to `false`. Not supported↵in Firefox." } ], "required": false, - "comment": "Whether the `meta viewport` tag is taken into account and touch events are enabled. Defaults to `false`. Not supported\nin Firefox.", - "deprecated": false, + "comment": "Whether the `meta viewport` tag is taken into account and touch events are enabled. Defaults to `false`. Not\nsupported in Firefox.", "async": false, "alias": "isMobile", "overloadIndex": 0, @@ -2502,7 +2979,6 @@ ], "required": false, "comment": "Whether or not to enable JavaScript in the context. Defaults to `true`.", - "deprecated": false, "async": false, "alias": "javaScriptEnabled", "overloadIndex": 0, @@ -2521,12 +2997,11 @@ "spec": [ { "type": "text", - "text": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value, `Accept-Language` request header value as well as number and date formatting rules." + "text": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value, `Accept-Language`↵request header value as well as number and date formatting rules." } ], "required": false, - "comment": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value, `Accept-Language`\nrequest header value as well as number and date formatting rules.", - "deprecated": false, + "comment": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value,\n`Accept-Language` request header value as well as number and date formatting rules.", "async": false, "alias": "locale", "overloadIndex": 0, @@ -2557,7 +3032,6 @@ ], "required": false, "comment": "Logger sink for Playwright logging.", - "deprecated": false, "async": false, "alias": "logger", "overloadIndex": 0, @@ -2588,7 +3062,6 @@ ], "required": false, "comment": "Does not enforce fixed viewport, allows resizing window in the headed mode.", - "deprecated": false, "async": false, "alias": "noViewport", "overloadIndex": 0, @@ -2612,7 +3085,6 @@ ], "required": false, "comment": "Whether to emulate network being offline. Defaults to `false`.", - "deprecated": false, "async": false, "alias": "offline", "overloadIndex": 0, @@ -2636,17 +3108,133 @@ "spec": [ { "type": "text", - "text": "A list of permissions to grant to all pages in this context. See [`method: BrowserContext.grantPermissions`] for more details." + "text": "A list of permissions to grant to all pages in this context. See↵[`method: BrowserContext.grantPermissions`] for more details." } ], "required": false, - "comment": "A list of permissions to grant to all pages in this context. See [`method: BrowserContext.grantPermissions`] for more\ndetails.", - "deprecated": false, + "comment": "A list of permissions to grant to all pages in this context. See [`method: BrowserContext.grantPermissions`] for\nmore details.", "async": false, "alias": "permissions", "overloadIndex": 0, "paramOrOption": null }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.29", + "name": "proxy", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "server", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example↵`http://myproxy.com:3128` or `socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP↵proxy." + } + ], + "required": true, + "comment": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example `http://myproxy.com:3128` or\n`socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP proxy.", + "async": false, + "alias": "server", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "bypass", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Optional comma-separated domains to bypass proxy, for example `\".com, chromium.org,↵.domain.com\"`." + } + ], + "required": false, + "comment": "Optional comma-separated domains to bypass proxy, for example `\".com, chromium.org, .domain.com\"`.", + "async": false, + "alias": "bypass", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "username", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Optional username to use if HTTP proxy requires authentication." + } + ], + "required": false, + "comment": "Optional username to use if HTTP proxy requires authentication.", + "async": false, + "alias": "username", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "password", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Optional password to use if HTTP proxy requires authentication." + } + ], + "required": false, + "comment": "Optional password to use if HTTP proxy requires authentication.", + "async": false, + "alias": "password", + "overloadIndex": 0, + "paramOrOption": null + } + ], + "expression": "[Object]" + }, + "spec": [ + { + "type": "text", + "text": "Network proxy settings." + } + ], + "required": false, + "comment": "Network proxy settings.", + "async": false, + "alias": "proxy", + "overloadIndex": 0, + "paramOrOption": null + }, { "kind": "property", "langs": { @@ -2676,12 +3264,11 @@ "spec": [ { "type": "text", - "text": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`. Deprecated, use `content` policy instead." + "text": "Optional setting to control whether to omit request content from the HAR. Defaults to↵`false`. Deprecated, use `content` policy instead." } ], "required": false, - "comment": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`. Deprecated, use `content`\npolicy instead.", - "deprecated": false, + "comment": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`. Deprecated, use\n`content` policy instead.", "async": false, "alias": "omitContent", "overloadIndex": 0, @@ -2711,12 +3298,11 @@ "spec": [ { "type": "text", - "text": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach` is specified, resources are persistet as separate files or entries in the ZIP archive. If `embed` is specified, content is stored inline the HAR file as per HAR specification. Defaults to `attach` for `.zip` output files and to `embed` for all other file extensions." + "text": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach` is specified, resources are persisted as separate files or entries in the ZIP archive. If `embed` is specified, content is stored inline the HAR file as per HAR specification. Defaults to `attach` for `.zip` output files and to `embed` for all other file extensions." } ], "required": false, - "comment": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach`\nis specified, resources are persistet as separate files or entries in the ZIP archive. If `embed` is specified, content\nis stored inline the HAR file as per HAR specification. Defaults to `attach` for `.zip` output files and to `embed` for\nall other file extensions.", - "deprecated": false, + "comment": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If\n`attach` is specified, resources are persisted as separate files or entries in the ZIP archive. If `embed` is\nspecified, content is stored inline the HAR file as per HAR specification. Defaults to `attach` for `.zip` output\nfiles and to `embed` for all other file extensions.", "async": false, "alias": "content", "overloadIndex": 0, @@ -2740,7 +3326,6 @@ ], "required": true, "comment": "Path on the filesystem to write the HAR file to. If the file name ends with `.zip`, `content: 'attach'` is used by\ndefault.", - "deprecated": false, "async": false, "alias": "path", "overloadIndex": 0, @@ -2771,8 +3356,7 @@ } ], "required": false, - "comment": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies,\nsecurity and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.", - "deprecated": false, + "comment": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page,\ncookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.", "async": false, "alias": "mode", "overloadIndex": 0, @@ -2804,7 +3388,6 @@ ], "required": false, "comment": "A glob or regex pattern to filter requests that are stored in the HAR. When a `baseURL` via the context options was\nprovided and the passed URL is a path, it gets merged via the\n[`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor.", - "deprecated": false, "async": false, "alias": "urlFilter", "overloadIndex": 0, @@ -2816,12 +3399,11 @@ "spec": [ { "type": "text", - "text": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into `recordHar.path` file. If not specified, the HAR is not recorded. Make sure to await [`method: BrowserContext.close`] for the HAR to be saved." + "text": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into `recordHar.path` file. If not↵specified, the HAR is not recorded. Make sure to await [`method: BrowserContext.close`] for the HAR to be↵saved." } ], "required": false, - "comment": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into `recordHar.path` file. If not\nspecified, the HAR is not recorded. Make sure to await [`method: BrowserContext.close`] for the HAR to be saved.", - "deprecated": false, + "comment": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into `recordHar.path` file.\nIf not specified, the HAR is not recorded. Make sure to await [`method: BrowserContext.close`] for the HAR to be\nsaved.", "async": false, "alias": "recordHar", "overloadIndex": 0, @@ -2862,12 +3444,11 @@ "spec": [ { "type": "text", - "text": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach` is specified, resources are persistet as separate files and all of these files are archived along with the HAR file. Defaults to `embed`, which stores content inline the HAR file as per HAR specification." + "text": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach` is specified, resources are persisted as separate files and all of these files are archived along with the HAR file. Defaults to `embed`, which stores content inline the HAR file as per HAR specification." } ], "required": false, - "comment": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach`\nis specified, resources are persistet as separate files and all of these files are archived along with the HAR file.\nDefaults to `embed`, which stores content inline the HAR file as per HAR specification.", - "deprecated": false, + "comment": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If\n`attach` is specified, resources are persisted as separate files and all of these files are archived along with the\nHAR file. Defaults to `embed`, which stores content inline the HAR file as per HAR specification.", "async": false, "alias": "recordHarContent", "overloadIndex": 0, @@ -2909,8 +3490,7 @@ } ], "required": false, - "comment": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies,\nsecurity and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.", - "deprecated": false, + "comment": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page,\ncookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.", "async": false, "alias": "recordHarMode", "overloadIndex": 0, @@ -2945,7 +3525,6 @@ ], "required": false, "comment": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`.", - "deprecated": false, "async": false, "alias": "recordHarOmitContent", "overloadIndex": 0, @@ -2975,12 +3554,11 @@ "spec": [ { "type": "text", - "text": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the specified HAR file on the filesystem. If not specified, the HAR is not recorded. Make sure to call [`method: BrowserContext.close`] for the HAR to be saved." + "text": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the↵specified HAR file on the filesystem. If not specified, the HAR is not recorded. Make sure to↵call [`method: BrowserContext.close`] for the HAR to be saved." } ], "required": false, - "comment": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the specified HAR file on the\nfilesystem. If not specified, the HAR is not recorded. Make sure to call [`method: BrowserContext.close`] for the HAR to\nbe saved.", - "deprecated": false, + "comment": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the specified HAR file\non the filesystem. If not specified, the HAR is not recorded. Make sure to call [`method: BrowserContext.close`]\nfor the HAR to be saved.", "async": false, "alias": "recordHarPath", "overloadIndex": 0, @@ -3018,7 +3596,6 @@ "spec": [], "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "recordHarUrlFilter", "overloadIndex": 0, @@ -3058,7 +3635,6 @@ ], "required": true, "comment": "Path to the directory to put videos into.", - "deprecated": false, "async": false, "alias": "dir", "overloadIndex": 0, @@ -3091,7 +3667,6 @@ ], "required": true, "comment": "Video frame width.", - "deprecated": false, "async": false, "alias": "width", "overloadIndex": 0, @@ -3115,7 +3690,6 @@ ], "required": true, "comment": "Video frame height.", - "deprecated": false, "async": false, "alias": "height", "overloadIndex": 0, @@ -3127,12 +3701,11 @@ "spec": [ { "type": "text", - "text": "Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size." + "text": "Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport`↵scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450.↵Actual picture of each page will be scaled down if necessary to fit the specified size." } ], "required": false, - "comment": "Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit\ninto 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page\nwill be scaled down if necessary to fit the specified size.", - "deprecated": false, + "comment": "Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to\nfit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of\neach page will be scaled down if necessary to fit the specified size.", "async": false, "alias": "size", "overloadIndex": 0, @@ -3144,12 +3717,11 @@ "spec": [ { "type": "text", - "text": "Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make sure to await [`method: BrowserContext.close`] for videos to be saved." + "text": "Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make↵sure to await [`method: BrowserContext.close`] for videos to be saved." } ], "required": false, - "comment": "Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make\nsure to await [`method: BrowserContext.close`] for videos to be saved.", - "deprecated": false, + "comment": "Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded.\nMake sure to await [`method: BrowserContext.close`] for videos to be saved.", "async": false, "alias": "recordVideo", "overloadIndex": 0, @@ -3179,12 +3751,11 @@ "spec": [ { "type": "text", - "text": "Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make sure to call [`method: BrowserContext.close`] for videos to be saved." + "text": "Enables video recording for all pages into the specified directory. If not specified videos are↵not recorded. Make sure to call [`method: BrowserContext.close`] for videos to be saved." } ], "required": false, - "comment": "Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make sure\nto call [`method: BrowserContext.close`] for videos to be saved.", - "deprecated": false, + "comment": "Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make\nsure to call [`method: BrowserContext.close`] for videos to be saved.", "async": false, "alias": "recordVideoDir", "overloadIndex": 0, @@ -3228,7 +3799,6 @@ ], "required": true, "comment": "Video frame width.", - "deprecated": false, "async": false, "alias": "width", "overloadIndex": 0, @@ -3252,7 +3822,6 @@ ], "required": true, "comment": "Video frame height.", - "deprecated": false, "async": false, "alias": "height", "overloadIndex": 0, @@ -3264,12 +3833,11 @@ "spec": [ { "type": "text", - "text": "Dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size." + "text": "Dimensions of the recorded videos. If not specified the size will be equal to `viewport`↵scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450.↵Actual picture of each page will be scaled down if necessary to fit the specified size." } ], "required": false, - "comment": "Dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit into\n800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page will\nbe scaled down if necessary to fit the specified size.", - "deprecated": false, + "comment": "Dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit into\n800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page\nwill be scaled down if necessary to fit the specified size.", "async": false, "alias": "recordVideoSize", "overloadIndex": 0, @@ -3277,7 +3845,62 @@ }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "js", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.9", + "name": "reducedMotion", + "type": { + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "ReducedMotion", + "union": [ + { + "name": "\"reduce\"" + }, + { + "name": "\"no-preference\"" + } + ] + } + ], + "expression": "null|[ReducedMotion]<\"reduce\"|\"no-preference\">" + }, + "spec": [ + { + "type": "text", + "text": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See [`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to `'no-preference'`." + } + ], + "required": false, + "comment": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to\n`'no-preference'`.", + "async": false, + "alias": "reducedMotion", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, "since": "v1.9", "name": "reducedMotion", @@ -3289,19 +3912,21 @@ }, { "name": "\"no-preference\"" + }, + { + "name": "\"null\"" } ], - "expression": "[ReducedMotion]<\"reduce\"|\"no-preference\">" + "expression": "[ReducedMotion]<\"reduce\"|\"no-preference\"|\"null\">" }, "spec": [ { "type": "text", - "text": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See [`method: Page.emulateMedia`] for more details. Defaults to `'no-preference'`." + "text": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See [`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to `'no-preference'`." } ], "required": false, - "comment": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Defaults to `'no-preference'`.", - "deprecated": false, + "comment": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to\n`'no-preference'`.", "async": false, "alias": "reducedMotion", "overloadIndex": 0, @@ -3341,7 +3966,6 @@ ], "required": true, "comment": "page width in pixels.", - "deprecated": false, "async": false, "alias": "width", "overloadIndex": 0, @@ -3365,7 +3989,6 @@ ], "required": true, "comment": "page height in pixels.", - "deprecated": false, "async": false, "alias": "height", "overloadIndex": 0, @@ -3377,12 +4000,11 @@ "spec": [ { "type": "text", - "text": "Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the `viewport` is set." + "text": "Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the↵`viewport` is set." } ], "required": false, - "comment": "Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the `viewport`\nis set.", - "deprecated": false, + "comment": "Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the\n`viewport` is set.", "async": false, "alias": "screen", "overloadIndex": 0, @@ -3423,8 +4045,7 @@ } ], "required": false, - "comment": "Whether to allow sites to register Service workers. Defaults to `'allow'`.\n- `'allow'`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be registered.\n- `'block'`: Playwright will block all registration of Service Workers.", - "deprecated": false, + "comment": "Whether to allow sites to register Service workers. Defaults to `'allow'`.\n- `'allow'`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be\n registered.\n- `'block'`: Playwright will block all registration of Service Workers.", "async": false, "alias": "serviceWorkers", "overloadIndex": 0, @@ -3443,12 +4064,11 @@ "spec": [ { "type": "text", - "text": "If specified, enables strict selectors mode for this context. In the strict selectors mode all operations on selectors that imply single target DOM element will throw when more than one element matches the selector. See `Locator` to learn more about the strict mode." + "text": "If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations↵on selectors that imply single target DOM element will throw when more than one element matches the selector.↵This option does not affect any Locator APIs (Locators are always strict).↵See `Locator` to learn more about the strict mode." } ], "required": false, - "comment": "If specified, enables strict selectors mode for this context. In the strict selectors mode all operations on selectors\nthat imply single target DOM element will throw when more than one element matches the selector. See `Locator` to learn\nmore about the strict mode.", - "deprecated": false, + "comment": "If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations on\nselectors that imply single target DOM element will throw when more than one element matches the selector. This\noption does not affect any Locator APIs (Locators are always strict). See `Locator` to learn more about the strict\nmode.", "async": false, "alias": "strictSelectors", "overloadIndex": 0, @@ -3467,12 +4087,11 @@ "spec": [ { "type": "text", - "text": "Changes the timezone of the context. See [ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1) for a list of supported timezone IDs." + "text": "Changes the timezone of the context. See [ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1)↵for a list of supported timezone IDs." } ], "required": false, "comment": "Changes the timezone of the context. See\n[ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1)\nfor a list of supported timezone IDs.", - "deprecated": false, "async": false, "alias": "timezoneId", "overloadIndex": 0, @@ -3496,7 +4115,6 @@ ], "required": false, "comment": "Specific user agent to use in this context.", - "deprecated": false, "async": false, "alias": "userAgent", "overloadIndex": 0, @@ -3514,6 +4132,7 @@ }, "experimental": false, "since": "v1.9", + "deprecated": "Use `recordVideo` instead.", "name": "videoSize", "type": { "name": "Object", @@ -3536,7 +4155,6 @@ ], "required": true, "comment": "Video frame width.", - "deprecated": false, "async": false, "alias": "width", "overloadIndex": 0, @@ -3560,7 +4178,6 @@ ], "required": true, "comment": "Video frame height.", - "deprecated": false, "async": false, "alias": "height", "overloadIndex": 0, @@ -3569,15 +4186,9 @@ ], "expression": "[Object]" }, - "spec": [ - { - "type": "text", - "text": "**DEPRECATED** Use `recordVideo` instead." - } - ], + "spec": [], "required": false, - "comment": "**DEPRECATED** Use `recordVideo` instead.", - "deprecated": true, + "comment": "", "async": false, "alias": "videoSize", "overloadIndex": 0, @@ -3595,20 +4206,15 @@ }, "experimental": false, "since": "v1.9", + "deprecated": "Use `recordVideo` instead.", "name": "videosPath", "type": { "name": "path", "expression": "[path]" }, - "spec": [ - { - "type": "text", - "text": "**DEPRECATED** Use `recordVideo` instead." - } - ], + "spec": [], "required": false, - "comment": "**DEPRECATED** Use `recordVideo` instead.", - "deprecated": true, + "comment": "", "async": false, "alias": "videosPath", "overloadIndex": 0, @@ -3657,7 +4263,6 @@ ], "required": true, "comment": "page width in pixels.", - "deprecated": false, "async": false, "alias": "width", "overloadIndex": 0, @@ -3681,7 +4286,6 @@ ], "required": true, "comment": "page height in pixels.", - "deprecated": false, "async": false, "alias": "height", "overloadIndex": 0, @@ -3695,12 +4299,16 @@ "spec": [ { "type": "text", - "text": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. `null` disables the default viewport." + "text": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport.↵Use `null` to disable the consistent viewport emulation." + }, + { + "type": "note", + "noteType": "note", + "text": "The `null` value opts out from the default presets, makes viewport depend on the↵host window size defined by the operating system. It makes the execution of the↵tests non-deterministic." } ], "required": false, - "comment": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. `null` disables the default viewport.", - "deprecated": false, + "comment": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use `null` to disable the consistent\nviewport emulation.\n\n**NOTE** The `null` value opts out from the default presets, makes viewport depend on the host window size defined\nby the operating system. It makes the execution of the tests non-deterministic.", "async": false, "alias": "viewport", "overloadIndex": 0, @@ -3748,7 +4356,6 @@ ], "required": true, "comment": "page width in pixels.", - "deprecated": false, "async": false, "alias": "width", "overloadIndex": 0, @@ -3772,7 +4379,6 @@ ], "required": true, "comment": "page height in pixels.", - "deprecated": false, "async": false, "alias": "height", "overloadIndex": 0, @@ -3786,12 +4392,16 @@ "spec": [ { "type": "text", - "text": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use `ViewportSize.NoViewport` to disable the default viewport." + "text": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport.↵Use `ViewportSize.NoViewport` to disable the consistent viewport emulation." + }, + { + "type": "note", + "noteType": "note", + "text": "The `ViewportSize.NoViewport` value opts out from the default presets,↵makes viewport depend on the host window size defined by the operating system.↵It makes the execution of the tests non-deterministic." } ], "required": false, - "comment": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use `ViewportSize.NoViewport` to disable\nthe default viewport.", - "deprecated": false, + "comment": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use `ViewportSize.NoViewport` to\ndisable the consistent viewport emulation.\n\n**NOTE** The `ViewportSize.NoViewport` value opts out from the default presets, makes viewport depend on the host\nwindow size defined by the operating system. It makes the execution of the tests non-deterministic.", "async": false, "alias": "viewport", "overloadIndex": 0, @@ -3837,7 +4447,6 @@ ], "required": true, "comment": "page width in pixels.", - "deprecated": false, "async": false, "alias": "width", "overloadIndex": 0, @@ -3861,7 +4470,6 @@ ], "required": true, "comment": "page height in pixels.", - "deprecated": false, "async": false, "alias": "height", "overloadIndex": 0, @@ -3879,8 +4487,7 @@ } ], "required": false, - "comment": "Sets a consistent viewport for each page. Defaults to an 1280x720 viewport. `no_viewport` disables the fixed viewport.", - "deprecated": false, + "comment": "Sets a consistent viewport for each page. Defaults to an 1280x720 viewport. `no_viewport` disables the fixed\nviewport.", "async": false, "alias": "viewport", "overloadIndex": 0, @@ -3890,7 +4497,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -3915,7 +4521,6 @@ ], "required": true, "comment": "Performs a long tap on the widget defined by `selector`.", - "deprecated": false, "async": true, "alias": "longTap", "overloadIndex": 0, @@ -3939,7 +4544,6 @@ ], "required": true, "comment": "Selector to tap on.", - "deprecated": false, "async": false, "alias": "selector", "overloadIndex": 0, @@ -3974,12 +4578,11 @@ "spec": [ { "type": "text", - "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [`method: AndroidDevice.setDefaultTimeout`] method." + "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by↵using the [`method: AndroidDevice.setDefaultTimeout`] method." } ], "required": false, - "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by\nusing the [`method: AndroidDevice.setDefaultTimeout`] method.", - "deprecated": false, + "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed\nby using the [`method: AndroidDevice.setDefaultTimeout`] method.", "async": false, "alias": "timeout", "overloadIndex": 0, @@ -3989,7 +4592,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -4015,7 +4617,6 @@ ], "required": true, "comment": "Device model.", - "deprecated": false, "async": false, "alias": "model", "overloadIndex": 0, @@ -4040,7 +4641,6 @@ ], "required": true, "comment": "Launches a process in the shell on the device and returns a socket to communicate with the launched process.", - "deprecated": false, "async": true, "alias": "open", "overloadIndex": 0, @@ -4059,7 +4659,6 @@ "spec": [], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "command", "overloadIndex": 0, @@ -4084,7 +4683,6 @@ ], "required": true, "comment": "Pinches the widget defined by `selector` in the closing direction.", - "deprecated": false, "async": true, "alias": "pinchClose", "overloadIndex": 0, @@ -4108,7 +4706,6 @@ ], "required": true, "comment": "Selector to pinch close.", - "deprecated": false, "async": false, "alias": "selector", "overloadIndex": 0, @@ -4132,7 +4729,6 @@ ], "required": true, "comment": "The size of the pinch as a percentage of the widget's size.", - "deprecated": false, "async": false, "alias": "percent", "overloadIndex": 0, @@ -4165,7 +4761,6 @@ ], "required": false, "comment": "Optional speed of the pinch in pixels per second.", - "deprecated": false, "async": false, "alias": "speed", "overloadIndex": 0, @@ -4191,12 +4786,11 @@ "spec": [ { "type": "text", - "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [`method: AndroidDevice.setDefaultTimeout`] method." + "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by↵using the [`method: AndroidDevice.setDefaultTimeout`] method." } ], "required": false, - "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by\nusing the [`method: AndroidDevice.setDefaultTimeout`] method.", - "deprecated": false, + "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed\nby using the [`method: AndroidDevice.setDefaultTimeout`] method.", "async": false, "alias": "timeout", "overloadIndex": 0, @@ -4206,7 +4800,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -4231,7 +4824,6 @@ ], "required": true, "comment": "Pinches the widget defined by `selector` in the open direction.", - "deprecated": false, "async": true, "alias": "pinchOpen", "overloadIndex": 0, @@ -4255,7 +4847,6 @@ ], "required": true, "comment": "Selector to pinch open.", - "deprecated": false, "async": false, "alias": "selector", "overloadIndex": 0, @@ -4279,7 +4870,6 @@ ], "required": true, "comment": "The size of the pinch as a percentage of the widget's size.", - "deprecated": false, "async": false, "alias": "percent", "overloadIndex": 0, @@ -4312,7 +4902,6 @@ ], "required": false, "comment": "Optional speed of the pinch in pixels per second.", - "deprecated": false, "async": false, "alias": "speed", "overloadIndex": 0, @@ -4338,12 +4927,11 @@ "spec": [ { "type": "text", - "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [`method: AndroidDevice.setDefaultTimeout`] method." + "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by↵using the [`method: AndroidDevice.setDefaultTimeout`] method." } ], "required": false, - "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by\nusing the [`method: AndroidDevice.setDefaultTimeout`] method.", - "deprecated": false, + "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed\nby using the [`method: AndroidDevice.setDefaultTimeout`] method.", "async": false, "alias": "timeout", "overloadIndex": 0, @@ -4353,7 +4941,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -4378,7 +4965,6 @@ ], "required": true, "comment": "Presses the specific `key` in the widget defined by `selector`.", - "deprecated": false, "async": true, "alias": "press", "overloadIndex": 0, @@ -4402,7 +4988,6 @@ ], "required": true, "comment": "Selector to press the key in.", - "deprecated": false, "async": false, "alias": "selector", "overloadIndex": 0, @@ -4426,7 +5011,6 @@ ], "required": true, "comment": "The key to press.", - "deprecated": false, "async": false, "alias": "key", "overloadIndex": 0, @@ -4461,12 +5045,11 @@ "spec": [ { "type": "text", - "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [`method: AndroidDevice.setDefaultTimeout`] method." + "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by↵using the [`method: AndroidDevice.setDefaultTimeout`] method." } ], "required": false, - "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by\nusing the [`method: AndroidDevice.setDefaultTimeout`] method.", - "deprecated": false, + "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed\nby using the [`method: AndroidDevice.setDefaultTimeout`] method.", "async": false, "alias": "timeout", "overloadIndex": 0, @@ -4476,7 +5059,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -4501,7 +5083,6 @@ ], "required": true, "comment": "Copies a file to the device.", - "deprecated": false, "async": true, "alias": "push", "overloadIndex": 0, @@ -4533,7 +5114,6 @@ ], "required": true, "comment": "Either a path to the file, or file content.", - "deprecated": false, "async": false, "alias": "file", "overloadIndex": 0, @@ -4557,7 +5137,6 @@ ], "required": true, "comment": "Path to the file on the device.", - "deprecated": false, "async": false, "alias": "path", "overloadIndex": 0, @@ -4590,7 +5169,6 @@ ], "required": false, "comment": "Optional file mode, defaults to `644` (`rw-r--r--`).", - "deprecated": false, "async": false, "alias": "mode", "overloadIndex": 0, @@ -4600,7 +5178,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -4626,7 +5203,6 @@ ], "required": true, "comment": "Returns the buffer with the captured screenshot of the device.", - "deprecated": false, "async": true, "alias": "screenshot", "overloadIndex": 0, @@ -4654,12 +5230,11 @@ "spec": [ { "type": "text", - "text": "The file path to save the image to. If `path` is a relative path, then it is resolved relative to the current working directory. If no path is provided, the image won't be saved to the disk." + "text": "The file path to save the image to. If `path` is a↵relative path, then it is resolved relative to the current working directory. If no path is provided, the image won't be↵saved to the disk." } ], "required": false, - "comment": "The file path to save the image to. If `path` is a relative path, then it is resolved relative to the current working\ndirectory. If no path is provided, the image won't be saved to the disk.", - "deprecated": false, + "comment": "The file path to save the image to. If `path` is a relative path, then it is resolved relative to the current\nworking directory. If no path is provided, the image won't be saved to the disk.", "async": false, "alias": "path", "overloadIndex": 0, @@ -4669,7 +5244,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -4694,7 +5268,6 @@ ], "required": true, "comment": "Scrolls the widget defined by `selector` in the specified `direction`.", - "deprecated": false, "async": true, "alias": "scroll", "overloadIndex": 0, @@ -4718,7 +5291,6 @@ ], "required": true, "comment": "Selector to scroll.", - "deprecated": false, "async": false, "alias": "selector", "overloadIndex": 0, @@ -4756,7 +5328,6 @@ ], "required": true, "comment": "Scroll direction.", - "deprecated": false, "async": false, "alias": "direction", "overloadIndex": 0, @@ -4780,7 +5351,6 @@ ], "required": true, "comment": "Distance to scroll as a percentage of the widget's size.", - "deprecated": false, "async": false, "alias": "percent", "overloadIndex": 0, @@ -4813,7 +5383,6 @@ ], "required": false, "comment": "Optional speed of the scroll in pixels per second.", - "deprecated": false, "async": false, "alias": "speed", "overloadIndex": 0, @@ -4839,12 +5408,11 @@ "spec": [ { "type": "text", - "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [`method: AndroidDevice.setDefaultTimeout`] method." + "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by↵using the [`method: AndroidDevice.setDefaultTimeout`] method." } ], "required": false, - "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by\nusing the [`method: AndroidDevice.setDefaultTimeout`] method.", - "deprecated": false, + "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed\nby using the [`method: AndroidDevice.setDefaultTimeout`] method.", "async": false, "alias": "timeout", "overloadIndex": 0, @@ -4854,7 +5422,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -4880,7 +5447,6 @@ ], "required": true, "comment": "Device serial number.", - "deprecated": false, "async": false, "alias": "serial", "overloadIndex": 0, @@ -4904,7 +5470,6 @@ ], "required": true, "comment": "This setting will change the default maximum time for all the methods accepting `timeout` option.", - "deprecated": false, "async": false, "alias": "setDefaultTimeout", "overloadIndex": 0, @@ -4928,7 +5493,6 @@ ], "required": true, "comment": "Maximum time in milliseconds", - "deprecated": false, "async": false, "alias": "timeout", "overloadIndex": 0, @@ -4954,7 +5518,6 @@ ], "required": true, "comment": "Executes a shell command on the device and returns its output.", - "deprecated": false, "async": true, "alias": "shell", "overloadIndex": 0, @@ -4978,7 +5541,6 @@ ], "required": true, "comment": "Shell command to execute.", - "deprecated": false, "async": false, "alias": "command", "overloadIndex": 0, @@ -5003,7 +5565,6 @@ ], "required": true, "comment": "Swipes the widget defined by `selector` in the specified `direction`.", - "deprecated": false, "async": true, "alias": "swipe", "overloadIndex": 0, @@ -5027,7 +5588,6 @@ ], "required": true, "comment": "Selector to swipe.", - "deprecated": false, "async": false, "alias": "selector", "overloadIndex": 0, @@ -5065,7 +5625,6 @@ ], "required": true, "comment": "Swipe direction.", - "deprecated": false, "async": false, "alias": "direction", "overloadIndex": 0, @@ -5089,7 +5648,6 @@ ], "required": true, "comment": "Distance to swipe as a percentage of the widget's size.", - "deprecated": false, "async": false, "alias": "percent", "overloadIndex": 0, @@ -5122,7 +5680,6 @@ ], "required": false, "comment": "Optional speed of the swipe in pixels per second.", - "deprecated": false, "async": false, "alias": "speed", "overloadIndex": 0, @@ -5148,12 +5705,11 @@ "spec": [ { "type": "text", - "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [`method: AndroidDevice.setDefaultTimeout`] method." + "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by↵using the [`method: AndroidDevice.setDefaultTimeout`] method." } ], "required": false, - "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by\nusing the [`method: AndroidDevice.setDefaultTimeout`] method.", - "deprecated": false, + "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed\nby using the [`method: AndroidDevice.setDefaultTimeout`] method.", "async": false, "alias": "timeout", "overloadIndex": 0, @@ -5163,7 +5719,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -5188,7 +5743,6 @@ ], "required": true, "comment": "Taps on the widget defined by `selector`.", - "deprecated": false, "async": true, "alias": "tap", "overloadIndex": 0, @@ -5212,7 +5766,6 @@ ], "required": true, "comment": "Selector to tap on.", - "deprecated": false, "async": false, "alias": "selector", "overloadIndex": 0, @@ -5245,7 +5798,6 @@ ], "required": false, "comment": "Optional duration of the tap in milliseconds.", - "deprecated": false, "async": false, "alias": "duration", "overloadIndex": 0, @@ -5271,12 +5823,11 @@ "spec": [ { "type": "text", - "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [`method: AndroidDevice.setDefaultTimeout`] method." + "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by↵using the [`method: AndroidDevice.setDefaultTimeout`] method." } ], "required": false, - "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by\nusing the [`method: AndroidDevice.setDefaultTimeout`] method.", - "deprecated": false, + "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed\nby using the [`method: AndroidDevice.setDefaultTimeout`] method.", "async": false, "alias": "timeout", "overloadIndex": 0, @@ -5286,7 +5837,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -5311,7 +5861,6 @@ ], "required": true, "comment": "Waits for the specific `selector` to either appear or disappear, depending on the `state`.", - "deprecated": false, "async": true, "alias": "wait", "overloadIndex": 0, @@ -5335,7 +5884,6 @@ ], "required": true, "comment": "Selector to wait for.", - "deprecated": false, "async": false, "alias": "selector", "overloadIndex": 0, @@ -5383,7 +5931,6 @@ ], "required": false, "comment": "Optional state. Can be either:\n- default - wait for element to be present.\n- `'gone'` - wait for element to not be present.", - "deprecated": false, "async": false, "alias": "state", "overloadIndex": 0, @@ -5409,12 +5956,11 @@ "spec": [ { "type": "text", - "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [`method: AndroidDevice.setDefaultTimeout`] method." + "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by↵using the [`method: AndroidDevice.setDefaultTimeout`] method." } ], "required": false, - "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by\nusing the [`method: AndroidDevice.setDefaultTimeout`] method.", - "deprecated": false, + "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed\nby using the [`method: AndroidDevice.setDefaultTimeout`] method.", "async": false, "alias": "timeout", "overloadIndex": 0, @@ -5424,7 +5970,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -5450,7 +5995,6 @@ ], "required": true, "comment": "Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy\nvalue.", - "deprecated": false, "async": true, "alias": "waitForEvent", "overloadIndex": 0, @@ -5483,7 +6027,6 @@ ], "required": true, "comment": "Event name, same one typically passed into `*.on(event)`.", - "deprecated": false, "async": false, "alias": "event", "overloadIndex": 0, @@ -5522,7 +6065,6 @@ ], "required": true, "comment": "receives the event data and resolves to truthy value when the waiting should resolve.", - "deprecated": false, "async": false, "alias": "predicate", "overloadIndex": 0, @@ -5541,12 +6083,11 @@ "spec": [ { "type": "text", - "text": "maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [`method: AndroidDevice.setDefaultTimeout`]." + "text": "maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to↵disable timeout. The default value can be changed by using the [`method: AndroidDevice.setDefaultTimeout`]." } ], "required": false, - "comment": "maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default\nvalue can be changed by using the [`method: AndroidDevice.setDefaultTimeout`].", - "deprecated": false, + "comment": "maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The\ndefault value can be changed by using the [`method: AndroidDevice.setDefaultTimeout`].", "async": false, "alias": "timeout", "overloadIndex": 0, @@ -5565,7 +6106,6 @@ ], "required": false, "comment": "Either a predicate that receives an event or an options object. Optional.", - "deprecated": false, "async": false, "alias": "optionsOrPredicate", "overloadIndex": 0, @@ -5590,8 +6130,7 @@ } ], "required": true, - "comment": "This method waits until `AndroidWebView` matching the `selector` is opened and returns it. If there is already an open\n`AndroidWebView` matching the `selector`, returns immediately.", - "deprecated": false, + "comment": "This method waits until `AndroidWebView` matching the `selector` is opened and returns it. If there is already an\nopen `AndroidWebView` matching the `selector`, returns immediately.", "async": true, "alias": "webView", "overloadIndex": 0, @@ -5624,7 +6163,6 @@ ], "required": false, "comment": "Optional Package identifier.", - "deprecated": false, "async": false, "alias": "pkg", "overloadIndex": 0, @@ -5648,7 +6186,6 @@ ], "required": false, "comment": "Optional webview socket name.", - "deprecated": false, "async": false, "alias": "socketName", "overloadIndex": 0, @@ -5660,7 +6197,6 @@ "spec": [], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "selector", "overloadIndex": 0, @@ -5695,12 +6231,11 @@ "spec": [ { "type": "text", - "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [`method: AndroidDevice.setDefaultTimeout`] method." + "text": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by↵using the [`method: AndroidDevice.setDefaultTimeout`] method." } ], "required": false, - "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by\nusing the [`method: AndroidDevice.setDefaultTimeout`] method.", - "deprecated": false, + "comment": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed\nby using the [`method: AndroidDevice.setDefaultTimeout`] method.", "async": false, "alias": "timeout", "overloadIndex": 0, @@ -5710,7 +6245,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -5741,7 +6275,6 @@ ], "required": true, "comment": "Currently open WebViews.", - "deprecated": false, "async": false, "alias": "webViews", "overloadIndex": 0, @@ -5761,6 +6294,7 @@ "types": {}, "overrides": {} }, + "since": "v1.9", "members": [ { "kind": "method", @@ -5779,7 +6313,6 @@ ], "required": true, "comment": "Performs a drag between `from` and `to` points.", - "deprecated": false, "async": true, "alias": "drag", "overloadIndex": 0, @@ -5812,7 +6345,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "x", "overloadIndex": 0, @@ -5836,7 +6368,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "y", "overloadIndex": 0, @@ -5853,7 +6384,6 @@ ], "required": true, "comment": "The start point of the drag.", - "deprecated": false, "async": false, "alias": "from", "overloadIndex": 0, @@ -5886,7 +6416,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "x", "overloadIndex": 0, @@ -5910,7 +6439,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "y", "overloadIndex": 0, @@ -5927,7 +6455,6 @@ ], "required": true, "comment": "The end point of the drag.", - "deprecated": false, "async": false, "alias": "to", "overloadIndex": 0, @@ -5951,7 +6478,6 @@ ], "required": true, "comment": "The number of steps in the drag. Each step takes 5 milliseconds to complete.", - "deprecated": false, "async": false, "alias": "steps", "overloadIndex": 0, @@ -5976,7 +6502,6 @@ ], "required": true, "comment": "Presses the `key`.", - "deprecated": false, "async": true, "alias": "press", "overloadIndex": 0, @@ -6000,7 +6525,6 @@ ], "required": true, "comment": "Key to press.", - "deprecated": false, "async": false, "alias": "key", "overloadIndex": 0, @@ -6025,7 +6549,6 @@ ], "required": true, "comment": "Swipes following the path defined by `segments`.", - "deprecated": false, "async": true, "alias": "swipe", "overloadIndex": 0, @@ -6058,7 +6581,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "x", "overloadIndex": 0, @@ -6082,7 +6604,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "y", "overloadIndex": 0, @@ -6099,7 +6620,6 @@ ], "required": true, "comment": "The point to start swiping from.", - "deprecated": false, "async": false, "alias": "from", "overloadIndex": 0, @@ -6135,7 +6655,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "x", "overloadIndex": 0, @@ -6159,7 +6678,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "y", "overloadIndex": 0, @@ -6178,7 +6696,6 @@ ], "required": true, "comment": "Points following the `from` point in the swipe gesture.", - "deprecated": false, "async": false, "alias": "segments", "overloadIndex": 0, @@ -6201,8 +6718,7 @@ } ], "required": true, - "comment": "The number of steps for each segment. Each step takes 5 milliseconds to complete, so 100 steps means half a second per\neach segment.", - "deprecated": false, + "comment": "The number of steps for each segment. Each step takes 5 milliseconds to complete, so 100 steps means half a second\nper each segment.", "async": false, "alias": "steps", "overloadIndex": 0, @@ -6227,7 +6743,6 @@ ], "required": true, "comment": "Taps at the specified `point`.", - "deprecated": false, "async": true, "alias": "tap", "overloadIndex": 0, @@ -6260,7 +6775,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "x", "overloadIndex": 0, @@ -6284,7 +6798,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "y", "overloadIndex": 0, @@ -6301,7 +6814,6 @@ ], "required": true, "comment": "The point to tap at.", - "deprecated": false, "async": false, "alias": "point", "overloadIndex": 0, @@ -6326,7 +6838,6 @@ ], "required": true, "comment": "Types `text` into currently focused widget.", - "deprecated": false, "async": true, "alias": "type", "overloadIndex": 0, @@ -6350,7 +6861,6 @@ ], "required": true, "comment": "Text to type.", - "deprecated": false, "async": false, "alias": "text", "overloadIndex": 0, @@ -6377,6 +6887,7 @@ "overrides": {} }, "comment": "`AndroidSocket` is a way to communicate with a process launched on the `AndroidDevice`. Use\n[`method: AndroidDevice.open`] to open a socket.", + "since": "v1.9", "members": [ { "kind": "event", @@ -6395,7 +6906,6 @@ ], "required": true, "comment": "Emitted when the socket is closed.", - "deprecated": false, "async": false, "alias": "close", "overloadIndex": 0, @@ -6420,7 +6930,6 @@ ], "required": true, "comment": "Emitted when data is available to read from the socket.", - "deprecated": false, "async": false, "alias": "data", "overloadIndex": 0, @@ -6444,7 +6953,6 @@ ], "required": true, "comment": "Closes the socket.", - "deprecated": false, "async": true, "alias": "close", "overloadIndex": 0, @@ -6468,7 +6976,6 @@ ], "required": true, "comment": "Writes some `data` to the socket.", - "deprecated": false, "async": true, "alias": "write", "overloadIndex": 0, @@ -6492,7 +6999,6 @@ ], "required": true, "comment": "Data to write.", - "deprecated": false, "async": false, "alias": "data", "overloadIndex": 0, @@ -6519,6 +7025,7 @@ "overrides": {} }, "comment": "`AndroidWebView` represents a WebView open on the `AndroidDevice`. WebView is usually obtained using\n[`method: AndroidDevice.webView`].", + "since": "v1.9", "members": [ { "kind": "event", @@ -6537,7 +7044,6 @@ ], "required": true, "comment": "Emitted when the WebView is closed.", - "deprecated": false, "async": false, "alias": "close", "overloadIndex": 0, @@ -6562,7 +7068,6 @@ ], "required": true, "comment": "Connects to the WebView and returns a regular Playwright `Page` to interact with.", - "deprecated": false, "async": true, "alias": "page", "overloadIndex": 0, @@ -6587,7 +7092,6 @@ ], "required": true, "comment": "WebView process PID.", - "deprecated": false, "async": false, "alias": "pid", "overloadIndex": 0, @@ -6612,7 +7116,6 @@ ], "required": true, "comment": "WebView package identifier.", - "deprecated": false, "async": false, "alias": "pkg", "overloadIndex": 0, @@ -6626,11 +7129,12 @@ "spec": [ { "type": "text", - "text": "Exposes API that can be used for the Web API testing. This class is used for creating `APIRequestContext` instance which in turn can be used for sending web requests. An instance of this class can be obtained via [`property: Playwright.request`]. For more information see `APIRequestContext`." + "text": "Exposes API that can be used for the Web API testing. This class is used for creating↵`APIRequestContext` instance which in turn can be used for sending web requests. An instance↵of this class can be obtained via [`property: Playwright.request`]. For more information↵see `APIRequestContext`." } ], "langs": {}, - "comment": "Exposes API that can be used for the Web API testing. This class is used for creating `APIRequestContext` instance which\nin turn can be used for sending web requests. An instance of this class can be obtained via\n[`property: Playwright.request`]. For more information see `APIRequestContext`.", + "comment": "Exposes API that can be used for the Web API testing. This class is used for creating `APIRequestContext` instance\nwhich in turn can be used for sending web requests. An instance of this class can be obtained via\n[`property: Playwright.request`]. For more information see `APIRequestContext`.", + "since": "v1.16", "members": [ { "kind": "method", @@ -6650,7 +7154,6 @@ ], "required": true, "comment": "Creates new instances of `APIRequestContext`.", - "deprecated": false, "async": true, "alias": "newContext", "overloadIndex": 0, @@ -6698,7 +7201,6 @@ ], "required": false, "comment": "Methods like [`method: APIRequestContext.get`] take the base URL into consideration by using the\n[`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the corresponding URL.\nExamples:\n- baseURL: `http://localhost:3000` and sending request to `/bar.html` results in `http://localhost:3000/bar.html`\n- baseURL: `http://localhost:3000/foo/` and sending request to `./bar.html` results in\n `http://localhost:3000/foo/bar.html`\n- baseURL: `http://localhost:3000/foo` (without trailing slash) and navigating to `./bar.html` results in\n `http://localhost:3000/bar.html`", - "deprecated": false, "async": false, "alias": "baseURL", "overloadIndex": 0, @@ -6730,7 +7232,6 @@ ], "required": false, "comment": "An object containing additional HTTP headers to be sent with every request.", - "deprecated": false, "async": false, "alias": "extraHTTPHeaders", "overloadIndex": 0, @@ -6763,7 +7264,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "username", "overloadIndex": 0, @@ -6787,7 +7287,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "password", "overloadIndex": 0, @@ -6804,7 +7303,6 @@ ], "required": false, "comment": "Credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication).", - "deprecated": false, "async": false, "alias": "httpCredentials", "overloadIndex": 0, @@ -6828,7 +7326,6 @@ ], "required": false, "comment": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.", - "deprecated": false, "async": false, "alias": "ignoreHTTPSErrors", "overloadIndex": 0, @@ -6856,12 +7353,11 @@ "spec": [ { "type": "text", - "text": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example `http://myproxy.com:3128` or `socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP proxy." + "text": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example↵`http://myproxy.com:3128` or `socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP↵proxy." } ], "required": true, "comment": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example `http://myproxy.com:3128` or\n`socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP proxy.", - "deprecated": false, "async": false, "alias": "server", "overloadIndex": 0, @@ -6880,12 +7376,11 @@ "spec": [ { "type": "text", - "text": "Optional comma-separated domains to bypass proxy, for example `\".com, chromium.org, .domain.com\"`." + "text": "Optional comma-separated domains to bypass proxy, for example `\".com, chromium.org,↵.domain.com\"`." } ], "required": false, "comment": "Optional comma-separated domains to bypass proxy, for example `\".com, chromium.org, .domain.com\"`.", - "deprecated": false, "async": false, "alias": "bypass", "overloadIndex": 0, @@ -6909,7 +7404,6 @@ ], "required": false, "comment": "Optional username to use if HTTP proxy requires authentication.", - "deprecated": false, "async": false, "alias": "username", "overloadIndex": 0, @@ -6933,7 +7427,6 @@ ], "required": false, "comment": "Optional password to use if HTTP proxy requires authentication.", - "deprecated": false, "async": false, "alias": "password", "overloadIndex": 0, @@ -6950,7 +7443,6 @@ ], "required": false, "comment": "Network proxy settings.", - "deprecated": false, "async": false, "alias": "proxy", "overloadIndex": 0, @@ -7009,7 +7501,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "name", "overloadIndex": 0, @@ -7033,7 +7524,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "value", "overloadIndex": 0, @@ -7057,7 +7547,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "domain", "overloadIndex": 0, @@ -7081,7 +7570,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "path", "overloadIndex": 0, @@ -7105,7 +7593,6 @@ ], "required": true, "comment": "Unix time in seconds.", - "deprecated": false, "async": false, "alias": "expires", "overloadIndex": 0, @@ -7129,7 +7616,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "httpOnly", "overloadIndex": 0, @@ -7153,7 +7639,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "secure", "overloadIndex": 0, @@ -7188,7 +7673,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "sameSite", "overloadIndex": 0, @@ -7207,7 +7691,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "cookies", "overloadIndex": 0, @@ -7243,7 +7726,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "origin", "overloadIndex": 0, @@ -7279,7 +7761,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "name", "overloadIndex": 0, @@ -7303,7 +7784,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "value", "overloadIndex": 0, @@ -7322,7 +7802,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "localStorage", "overloadIndex": 0, @@ -7341,7 +7820,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "origins", "overloadIndex": 0, @@ -7355,12 +7833,11 @@ "spec": [ { "type": "text", - "text": "Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via [`method: BrowserContext.storageState`] or [`method: APIRequestContext.storageState`]. Either a path to the file with saved storage, or the value returned by one of [`method: BrowserContext.storageState`] or [`method: APIRequestContext.storageState`] methods." + "text": "Populates context with given storage state. This option can be used to initialize context with logged-in information↵obtained via [`method: BrowserContext.storageState`] or [`method: APIRequestContext.storageState`]. Either a path to the↵file with saved storage, or the value returned by one of [`method: BrowserContext.storageState`] or↵[`method: APIRequestContext.storageState`] methods." } ], "required": false, - "comment": "Populates context with given storage state. This option can be used to initialize context with logged-in information\nobtained via [`method: BrowserContext.storageState`] or [`method: APIRequestContext.storageState`]. Either a path to the\nfile with saved storage, or the value returned by one of [`method: BrowserContext.storageState`] or\n[`method: APIRequestContext.storageState`] methods.", - "deprecated": false, + "comment": "Populates context with given storage state. This option can be used to initialize context with logged-in\ninformation obtained via [`method: BrowserContext.storageState`] or [`method: APIRequestContext.storageState`].\nEither a path to the file with saved storage, or the value returned by one of\n[`method: BrowserContext.storageState`] or [`method: APIRequestContext.storageState`] methods.", "async": false, "alias": "storageState", "overloadIndex": 0, @@ -7387,12 +7864,11 @@ "spec": [ { "type": "text", - "text": "Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via [`method: BrowserContext.storageState`] or [`method: APIRequestContext.storageState`]. Either a path to the file with saved storage, or the value returned by one of [`method: BrowserContext.storageState`] or [`method: APIRequestContext.storageState`] methods." + "text": "Populates context with given storage state. This option can be used to initialize context with logged-in information↵obtained via [`method: BrowserContext.storageState`] or [`method: APIRequestContext.storageState`]. Either a path to the↵file with saved storage, or the value returned by one of [`method: BrowserContext.storageState`] or↵[`method: APIRequestContext.storageState`] methods." } ], "required": false, - "comment": "Populates context with given storage state. This option can be used to initialize context with logged-in information\nobtained via [`method: BrowserContext.storageState`] or [`method: APIRequestContext.storageState`]. Either a path to the\nfile with saved storage, or the value returned by one of [`method: BrowserContext.storageState`] or\n[`method: APIRequestContext.storageState`] methods.", - "deprecated": false, + "comment": "Populates context with given storage state. This option can be used to initialize context with logged-in\ninformation obtained via [`method: BrowserContext.storageState`] or [`method: APIRequestContext.storageState`].\nEither a path to the file with saved storage, or the value returned by one of\n[`method: BrowserContext.storageState`] or [`method: APIRequestContext.storageState`] methods.", "async": false, "alias": "storageState", "overloadIndex": 0, @@ -7419,12 +7895,11 @@ "spec": [ { "type": "text", - "text": "Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via [`method: BrowserContext.storageState`]. Path to the file with saved storage state." + "text": "Populates context with given storage state. This option can be used to initialize context with logged-in information↵obtained via [`method: BrowserContext.storageState`]. Path to the file with saved storage state." } ], "required": false, - "comment": "Populates context with given storage state. This option can be used to initialize context with logged-in information\nobtained via [`method: BrowserContext.storageState`]. Path to the file with saved storage state.", - "deprecated": false, + "comment": "Populates context with given storage state. This option can be used to initialize context with logged-in\ninformation obtained via [`method: BrowserContext.storageState`]. Path to the file with saved storage state.", "async": false, "alias": "storageStatePath", "overloadIndex": 0, @@ -7443,12 +7918,11 @@ "spec": [ { "type": "text", - "text": "Maximum time in milliseconds to wait for the response. Defaults to `30000` (30 seconds). Pass `0` to disable timeout." + "text": "Maximum time in milliseconds to wait for the response. Defaults to↵`30000` (30 seconds). Pass `0` to disable timeout." } ], "required": false, - "comment": "Maximum time in milliseconds to wait for the response. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.", - "deprecated": false, + "comment": "Maximum time in milliseconds to wait for the response. Defaults to `30000` (30 seconds). Pass `0` to disable\ntimeout.", "async": false, "alias": "timeout", "overloadIndex": 0, @@ -7472,7 +7946,6 @@ ], "required": false, "comment": "Specific user agent to use in this context.", - "deprecated": false, "async": false, "alias": "userAgent", "overloadIndex": 0, @@ -7482,7 +7955,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -7497,11 +7969,11 @@ "spec": [ { "type": "text", - "text": "This API is used for the Web API testing. You can use it to trigger API endpoints, configure micro-services, prepare environment or the service to your e2e test." + "text": "This API is used for the Web API testing. You can use it to trigger API endpoints, configure micro-services, prepare↵environment or the service to your e2e test." }, { "type": "text", - "text": "Each Playwright browser context has associated with it `APIRequestContext` instance which shares cookie storage with the browser context and can be accessed via [`property: BrowserContext.request`] or [`property: Page.request`]. It is also possible to create a new APIRequestContext instance manually by calling [`method: APIRequest.newContext`]." + "text": "Each Playwright browser context has associated with it `APIRequestContext` instance which shares cookie storage with↵the browser context and can be accessed via [`property: BrowserContext.request`] or [`property: Page.request`].↵It is also possible to create a new APIRequestContext instance manually by calling [`method: APIRequest.newContext`]." }, { "type": "text", @@ -7509,11 +7981,11 @@ }, { "type": "text", - "text": "`APIRequestContext` retuned by [`property: BrowserContext.request`] and [`property: Page.request`] shares cookie storage with the corresponding `BrowserContext`. Each API request will have `Cookie` header populated with the values from the browser context. If the API response contains `Set-Cookie` header it will automatically update `BrowserContext` cookies and requests made from the page will pick them up. This means that if you log in using this API, your e2e test will be logged in and vice versa." + "text": "`APIRequestContext` returned by [`property: BrowserContext.request`] and [`property: Page.request`] shares cookie↵storage with the corresponding `BrowserContext`. Each API request will have `Cookie` header populated with the↵values from the browser context. If the API response contains `Set-Cookie` header it will automatically update↵`BrowserContext` cookies and requests made from the page will pick them up. This means that if you log in using↵this API, your e2e test will be logged in and vice versa." }, { "type": "text", - "text": "If you want API requests to not interfere with the browser cookies you shoud create a new `APIRequestContext` by calling [`method: APIRequest.newContext`]. Such `APIRequestContext` object will have its own isolated cookie storage." + "text": "If you want API requests to not interfere with the browser cookies you should create a new `APIRequestContext` by↵calling [`method: APIRequest.newContext`]. Such `APIRequestContext` object will have its own isolated cookie↵storage." }, { "type": "code", @@ -7529,7 +8001,7 @@ "async def run(playwright: Playwright):", " # This will launch a new browser, create a context and page. When making HTTP", " # requests with the internal APIRequestContext (e.g. `context.request` or `page.request`)", - " # it will automatically set the cookies to the browser page and vise versa.", + " # it will automatically set the cookies to the browser page and vice versa.", " browser = await playwright.chromium.launch()", " context = await browser.new_context(base_url=\"https://api.github.com\")", " api_request_context = context.request", @@ -7584,7 +8056,7 @@ "with sync_playwright() as p:", " # This will launch a new browser, create a context and page. When making HTTP", " # requests with the internal APIRequestContext (e.g. `context.request` or `page.request`)", - " # it will automatically set the cookies to the browser page and vise versa.", + " # it will automatically set the cookies to the browser page and vice versa.", " browser = p.chromium.launch()", " context = browser.new_context(base_url=\"https://api.github.com\")", " api_request_context = context.request", @@ -7623,7 +8095,8 @@ } ], "langs": {}, - "comment": "This API is used for the Web API testing. You can use it to trigger API endpoints, configure micro-services, prepare\nenvironment or the service to your e2e test.\n\nEach Playwright browser context has associated with it `APIRequestContext` instance which shares cookie storage with the\nbrowser context and can be accessed via [`property: BrowserContext.request`] or [`property: Page.request`]. It is also\npossible to create a new APIRequestContext instance manually by calling [`method: APIRequest.newContext`].\n\n**Cookie management**\n\n`APIRequestContext` retuned by [`property: BrowserContext.request`] and [`property: Page.request`] shares cookie storage\nwith the corresponding `BrowserContext`. Each API request will have `Cookie` header populated with the values from the\nbrowser context. If the API response contains `Set-Cookie` header it will automatically update `BrowserContext` cookies\nand requests made from the page will pick them up. This means that if you log in using this API, your e2e test will be\nlogged in and vice versa.\n\nIf you want API requests to not interfere with the browser cookies you shoud create a new `APIRequestContext` by calling\n[`method: APIRequest.newContext`]. Such `APIRequestContext` object will have its own isolated cookie storage.\n\n```python async\nimport os\nimport asyncio\nfrom playwright.async_api import async_playwright, Playwright\n\nREPO = \"test-repo-1\"\nUSER = \"github-username\"\nAPI_TOKEN = os.getenv(\"GITHUB_API_TOKEN\")\n\nasync def run(playwright: Playwright):\n # This will launch a new browser, create a context and page. When making HTTP\n # requests with the internal APIRequestContext (e.g. `context.request` or `page.request`)\n # it will automatically set the cookies to the browser page and vise versa.\n browser = await playwright.chromium.launch()\n context = await browser.new_context(base_url=\"https://api.github.com\")\n api_request_context = context.request\n page = await context.new_page()\n\n # Alternatively you can create a APIRequestContext manually without having a browser context attached:\n # api_request_context = await playwright.request.new_context(base_url=\"https://api.github.com\")\n\n # Create a repository.\n response = await api_request_context.post(\n \"/user/repos\",\n headers={\n \"Accept\": \"application/vnd.github.v3+json\",\n # Add GitHub personal access token.\n \"Authorization\": f\"token {API_TOKEN}\",\n },\n data={\"name\": REPO},\n )\n assert response.ok\n assert response.json()[\"name\"] == REPO\n\n # Delete a repository.\n response = await api_request_context.delete(\n f\"/repos/{USER}/{REPO}\",\n headers={\n \"Accept\": \"application/vnd.github.v3+json\",\n # Add GitHub personal access token.\n \"Authorization\": f\"token {API_TOKEN}\",\n },\n )\n assert response.ok\n assert await response.body() == '{\"status\": \"ok\"}'\n\nasync def main():\n async with async_playwright() as playwright:\n await run(playwright)\n\nasyncio.run(main())\n```\n\n```python sync\nimport os\nfrom playwright.sync_api import sync_playwright\n\nREPO = \"test-repo-1\"\nUSER = \"github-username\"\nAPI_TOKEN = os.getenv(\"GITHUB_API_TOKEN\")\n\nwith sync_playwright() as p:\n # This will launch a new browser, create a context and page. When making HTTP\n # requests with the internal APIRequestContext (e.g. `context.request` or `page.request`)\n # it will automatically set the cookies to the browser page and vise versa.\n browser = p.chromium.launch()\n context = browser.new_context(base_url=\"https://api.github.com\")\n api_request_context = context.request\n page = context.new_page()\n\n # Alternatively you can create a APIRequestContext manually without having a browser context attached:\n # api_request_context = p.request.new_context(base_url=\"https://api.github.com\")\n\n\n # Create a repository.\n response = api_request_context.post(\n \"/user/repos\",\n headers={\n \"Accept\": \"application/vnd.github.v3+json\",\n # Add GitHub personal access token.\n \"Authorization\": f\"token {API_TOKEN}\",\n },\n data={\"name\": REPO},\n )\n assert response.ok\n assert response.json()[\"name\"] == REPO\n\n # Delete a repository.\n response = api_request_context.delete(\n f\"/repos/{USER}/{REPO}\",\n headers={\n \"Accept\": \"application/vnd.github.v3+json\",\n # Add GitHub personal access token.\n \"Authorization\": f\"token {API_TOKEN}\",\n },\n )\n assert response.ok\n assert await response.body() == '{\"status\": \"ok\"}'\n```\n", + "comment": "This API is used for the Web API testing. You can use it to trigger API endpoints, configure micro-services,\nprepare environment or the service to your e2e test.\n\nEach Playwright browser context has associated with it `APIRequestContext` instance which shares cookie storage\nwith the browser context and can be accessed via [`property: BrowserContext.request`] or\n[`property: Page.request`]. It is also possible to create a new APIRequestContext instance manually by calling\n[`method: APIRequest.newContext`].\n\n**Cookie management**\n\n`APIRequestContext` returned by [`property: BrowserContext.request`] and [`property: Page.request`] shares cookie\nstorage with the corresponding `BrowserContext`. Each API request will have `Cookie` header populated with the\nvalues from the browser context. If the API response contains `Set-Cookie` header it will automatically update\n`BrowserContext` cookies and requests made from the page will pick them up. This means that if you log in using\nthis API, your e2e test will be logged in and vice versa.\n\nIf you want API requests to not interfere with the browser cookies you should create a new `APIRequestContext` by\ncalling [`method: APIRequest.newContext`]. Such `APIRequestContext` object will have its own isolated cookie\nstorage.\n\n```py\nimport os\nimport asyncio\nfrom playwright.async_api import async_playwright, Playwright\n\nREPO = \"test-repo-1\"\nUSER = \"github-username\"\nAPI_TOKEN = os.getenv(\"GITHUB_API_TOKEN\")\n\nasync def run(playwright: Playwright):\n # This will launch a new browser, create a context and page. When making HTTP\n # requests with the internal APIRequestContext (e.g. `context.request` or `page.request`)\n # it will automatically set the cookies to the browser page and vice versa.\n browser = await playwright.chromium.launch()\n context = await browser.new_context(base_url=\"https://api.github.com\")\n api_request_context = context.request\n page = await context.new_page()\n\n # Alternatively you can create a APIRequestContext manually without having a browser context attached:\n # api_request_context = await playwright.request.new_context(base_url=\"https://api.github.com\")\n\n # Create a repository.\n response = await api_request_context.post(\n \"/user/repos\",\n headers={\n \"Accept\": \"application/vnd.github.v3+json\",\n # Add GitHub personal access token.\n \"Authorization\": f\"token {API_TOKEN}\",\n },\n data={\"name\": REPO},\n )\n assert response.ok\n assert response.json()[\"name\"] == REPO\n\n # Delete a repository.\n response = await api_request_context.delete(\n f\"/repos/{USER}/{REPO}\",\n headers={\n \"Accept\": \"application/vnd.github.v3+json\",\n # Add GitHub personal access token.\n \"Authorization\": f\"token {API_TOKEN}\",\n },\n )\n assert response.ok\n assert await response.body() == '{\"status\": \"ok\"}'\n\nasync def main():\n async with async_playwright() as playwright:\n await run(playwright)\n\nasyncio.run(main())\n```\n\n```py\nimport os\nfrom playwright.sync_api import sync_playwright\n\nREPO = \"test-repo-1\"\nUSER = \"github-username\"\nAPI_TOKEN = os.getenv(\"GITHUB_API_TOKEN\")\n\nwith sync_playwright() as p:\n # This will launch a new browser, create a context and page. When making HTTP\n # requests with the internal APIRequestContext (e.g. `context.request` or `page.request`)\n # it will automatically set the cookies to the browser page and vice versa.\n browser = p.chromium.launch()\n context = browser.new_context(base_url=\"https://api.github.com\")\n api_request_context = context.request\n page = context.new_page()\n\n # Alternatively you can create a APIRequestContext manually without having a browser context attached:\n # api_request_context = p.request.new_context(base_url=\"https://api.github.com\")\n\n\n # Create a repository.\n response = api_request_context.post(\n \"/user/repos\",\n headers={\n \"Accept\": \"application/vnd.github.v3+json\",\n # Add GitHub personal access token.\n \"Authorization\": f\"token {API_TOKEN}\",\n },\n data={\"name\": REPO},\n )\n assert response.ok\n assert response.json()[\"name\"] == REPO\n\n # Delete a repository.\n response = api_request_context.delete(\n f\"/repos/{USER}/{REPO}\",\n headers={\n \"Accept\": \"application/vnd.github.v3+json\",\n # Add GitHub personal access token.\n \"Authorization\": f\"token {API_TOKEN}\",\n },\n )\n assert response.ok\n assert await response.body() == '{\"status\": \"ok\"}'\n```\n", + "since": "v1.16", "members": [ { "kind": "method", @@ -7650,7 +8123,6 @@ ], "required": true, "comment": "Creates a new `FormData` instance which is used for providing form and multipart data when making HTTP requests.", - "deprecated": false, "async": false, "alias": "createFormData", "overloadIndex": 0, @@ -7670,12 +8142,11 @@ "spec": [ { "type": "text", - "text": "Sends HTTP(S) [DELETE](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE) request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects." + "text": "Sends HTTP(S) [DELETE](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE) request and returns its response.↵The method will populate request cookies from the context and update↵context cookies from the response. The method will automatically follow redirects." } ], "required": true, - "comment": "Sends HTTP(S) [DELETE](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE) request and returns its\nresponse. The method will populate request cookies from the context and update context cookies from the response. The\nmethod will automatically follow redirects.", - "deprecated": false, + "comment": "Sends HTTP(S) [DELETE](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE) request and returns its\nresponse. The method will populate request cookies from the context and update context cookies from the response.\nThe method will automatically follow redirects.", "async": true, "alias": "delete", "overloadIndex": 0, @@ -7699,7 +8170,6 @@ ], "required": true, "comment": "Target URL.", - "deprecated": false, "async": false, "alias": "url", "overloadIndex": 0, @@ -7730,7 +8200,6 @@ ], "required": false, "comment": "Optional request parameters.", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -7778,12 +8247,11 @@ "spec": [ { "type": "text", - "text": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will be set to `application/octet-stream` if not explicitly set." + "text": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string↵and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will be↵set to `application/octet-stream` if not explicitly set." } ], "required": false, - "comment": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string and\n`content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will\nbe set to `application/octet-stream` if not explicitly set.", - "deprecated": false, + "comment": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string\nand `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type`\nheader will be set to `application/octet-stream` if not explicitly set.", "async": false, "alias": "data", "overloadIndex": 0, @@ -7811,12 +8279,11 @@ "spec": [ { "type": "text", - "text": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes." + "text": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned↵for all status codes." } ], "required": false, - "comment": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes.", - "deprecated": false, + "comment": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status\ncodes.", "async": false, "alias": "failOnStatusCode", "overloadIndex": 0, @@ -7862,12 +8329,11 @@ "spec": [ { "type": "text", - "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded` unless explicitly provided." + "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded`↵unless explicitly provided." } ], "required": false, - "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as\nthis request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent\nas this request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.", "async": false, "alias": "form", "overloadIndex": 0, @@ -7893,7 +8359,7 @@ "spec": [ { "type": "text", - "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded` unless explicitly provided." + "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded`↵unless explicitly provided." }, { "type": "text", @@ -7901,8 +8367,7 @@ } ], "required": false, - "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as\nthis request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent\nas this request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", "async": false, "alias": "form", "overloadIndex": 0, @@ -7938,12 +8403,11 @@ "spec": [ { "type": "text", - "text": "Allows to set HTTP headers." + "text": "Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by it." } ], "required": false, - "comment": "Allows to set HTTP headers.", - "deprecated": false, + "comment": "Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by\nit.", "async": false, "alias": "headers", "overloadIndex": 0, @@ -7976,12 +8440,43 @@ ], "required": false, "comment": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.", - "deprecated": false, "async": false, "alias": "ignoreHTTPSErrors", "overloadIndex": 0, "paramOrOption": null }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "python", + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.26", + "name": "maxRedirects", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded.↵Defaults to `20`. Pass `0` to not follow redirects." + } + ], + "required": false, + "comment": "Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is\nexceeded. Defaults to `20`. Pass `0` to not follow redirects.", + "async": false, + "alias": "maxRedirects", + "overloadIndex": 0, + "paramOrOption": null + }, { "kind": "property", "langs": { @@ -8017,7 +8512,6 @@ ], "required": true, "comment": "File name", - "deprecated": false, "async": false, "alias": "name", "overloadIndex": 0, @@ -8041,7 +8535,6 @@ ], "required": true, "comment": "File type", - "deprecated": false, "async": false, "alias": "mimeType", "overloadIndex": 0, @@ -8065,7 +8558,6 @@ ], "required": true, "comment": "File content", - "deprecated": false, "async": false, "alias": "buffer", "overloadIndex": 0, @@ -8112,7 +8604,6 @@ ], "required": true, "comment": "File name", - "deprecated": false, "async": false, "alias": "name", "overloadIndex": 0, @@ -8136,7 +8627,6 @@ ], "required": true, "comment": "File type", - "deprecated": false, "async": false, "alias": "mimeType", "overloadIndex": 0, @@ -8160,7 +8650,6 @@ ], "required": true, "comment": "File content", - "deprecated": false, "async": false, "alias": "buffer", "overloadIndex": 0, @@ -8176,12 +8665,11 @@ "spec": [ { "type": "text", - "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file name, mime-type and its content." + "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data`↵unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)↵or as file-like object containing file name, mime-type and its content." } ], "required": false, - "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request\nbody. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly\nprovided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)\nor as file-like object containing file name, mime-type and its content.", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this\nrequest body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless\nexplicitly provided. File values can be passed either as\n[`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file\nname, mime-type and its content.", "async": false, "alias": "multipart", "overloadIndex": 0, @@ -8207,7 +8695,7 @@ "spec": [ { "type": "text", - "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file name, mime-type and its content." + "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data`↵unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)↵or as file-like object containing file name, mime-type and its content." }, { "type": "text", @@ -8215,8 +8703,7 @@ } ], "required": false, - "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request\nbody. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly\nprovided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)\nor as file-like object containing file name, mime-type and its content.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this\nrequest body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless\nexplicitly provided. File values can be passed either as\n[`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file\nname, mime-type and its content.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", "async": false, "alias": "multipart", "overloadIndex": 0, @@ -8267,7 +8754,6 @@ ], "required": false, "comment": "Query parameters to be sent with the URL.", - "deprecated": false, "async": false, "alias": "params", "overloadIndex": 0, @@ -8306,7 +8792,6 @@ ], "required": false, "comment": "Query parameters to be sent with the URL.", - "deprecated": false, "async": false, "alias": "params", "overloadIndex": 0, @@ -8339,7 +8824,6 @@ ], "required": false, "comment": "Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.", - "deprecated": false, "async": false, "alias": "timeout", "overloadIndex": 0, @@ -8349,7 +8833,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -8369,12 +8852,11 @@ "spec": [ { "type": "text", - "text": "All responses returned by [`method: APIRequestContext.get`] and similar methods are stored in the memory, so that you can later call [`method: APIResponse.body`]. This method discards all stored responses, and makes [`method: APIResponse.body`] throw \"Response disposed\" error." + "text": "All responses returned by [`method: APIRequestContext.get`] and similar methods are stored in the memory, so that you can later call [`method: APIResponse.body`]. This method↵discards all stored responses, and makes [`method: APIResponse.body`] throw \"Response disposed\" error." } ], "required": true, - "comment": "All responses returned by [`method: APIRequestContext.get`] and similar methods are stored in the memory, so that you\ncan later call [`method: APIResponse.body`]. This method discards all stored responses, and makes\n[`method: APIResponse.body`] throw \"Response disposed\" error.", - "deprecated": false, + "comment": "All responses returned by [`method: APIRequestContext.get`] and similar methods are stored in the memory, so that\nyou can later call [`method: APIResponse.body`]. This method discards all stored responses, and makes\n[`method: APIResponse.body`] throw \"Response disposed\" error.", "async": true, "alias": "dispose", "overloadIndex": 0, @@ -8394,12 +8876,139 @@ "spec": [ { "type": "text", - "text": "Sends HTTP(S) request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects." + "text": "Sends HTTP(S) request and returns its response. The method will populate request cookies from the context and update↵context cookies from the response. The method will automatically follow redirects. JSON objects can be passed directly to the request." + }, + { + "type": "text", + "text": "**Usage**" + }, + { + "type": "code", + "lines": [ + "await request.fetch('https://example.com/api/createBook', {", + " method: 'post',", + " data: {", + " title: 'Book Title',", + " author: 'John Doe',", + " }", + "});" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "Map data = new HashMap();", + "data.put(\"title\", \"Book Title\");", + "data.put(\"body\", \"John Doe\");", + "request.fetch(\"https://example.com/api/createBook\", RequestOptions.create().setMethod(\"post\").setData(data));" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "data = {", + " \"title\": \"Book Title\",", + " \"body\": \"John Doe\",", + "}", + "api_request_context.fetch(\"https://example.com/api/createBook\", method=\"post\", data=data)" + ], + "codeLang": "python" + }, + { + "type": "code", + "lines": [ + "var data = new Dictionary() {", + " { \"title\", \"Book Title\" },", + " { \"body\", \"John Doe\" }", + "};", + "await Request.FetchAsync(\"https://example.com/api/createBook\", new() { Method = \"post\", DataObject = data });" + ], + "codeLang": "csharp" + }, + { + "type": "text", + "text": "The common way to send file(s) in the body of a request is to encode it as form fields with `multipart/form-data` encoding. You can achieve that with Playwright API like this:" + }, + { + "type": "code", + "lines": [ + "// Open file as a stream and pass it to the request:", + "const stream = fs.createReadStream('team.csv');", + "await request.fetch('https://example.com/api/uploadTeamList', {", + " method: 'post',", + " multipart: {", + " fileField: stream", + " }", + "});", + "", + "// Or you can pass the file content directly as an object:", + "await request.fetch('https://example.com/api/uploadScript', {", + " method: 'post',", + " multipart: {", + " fileField: {", + " name: 'f.js',", + " mimeType: 'text/javascript',", + " buffer: Buffer.from('console.log(2022);')", + " }", + " }", + "});" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "// Pass file path to the form data constructor:", + "Path file = Paths.get(\"team.csv\");", + "APIResponse response = request.fetch(\"https://example.com/api/uploadTeamList\",", + " RequestOptions.create().setMethod(\"post\").setMultipart(", + " FormData.create().set(\"fileField\", file)));", + "", + "// Or you can pass the file content directly as FilePayload object:", + "FilePayload filePayload = new FilePayload(\"f.js\", \"text/javascript\",", + " \"console.log(2022);\".getBytes(StandardCharsets.UTF_8));", + "APIResponse response = request.fetch(\"https://example.com/api/uploadTeamList\",", + " RequestOptions.create().setMethod(\"post\").setMultipart(", + " FormData.create().set(\"fileField\", filePayload)));" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "api_request_context.fetch(", + " \"https://example.com/api/uploadScrip'\",", + " method=\"post\",", + " multipart={", + " \"fileField\": {", + " \"name\": \"f.js\",", + " \"mimeType\": \"text/javascript\",", + " \"buffer\": b\"console.log(2022);\",", + " },", + " })" + ], + "codeLang": "python" + }, + { + "type": "code", + "lines": [ + "var file = new FilePayload()", + "{", + " Name = \"f.js\",", + " MimeType = \"text/javascript\",", + " Buffer = System.Text.Encoding.UTF8.GetBytes(\"console.log(2022);\")", + "};", + "var multipart = Context.APIRequest.CreateFormData();", + "multipart.Set(\"fileField\", file);", + "await Request.FetchAsync(\"https://example.com/api/uploadScript\", new() { Method = \"post\", Multipart = multipart });" + ], + "codeLang": "csharp" } ], "required": true, - "comment": "Sends HTTP(S) request and returns its response. The method will populate request cookies from the context and update\ncontext cookies from the response. The method will automatically follow redirects.", - "deprecated": false, + "comment": "Sends HTTP(S) request and returns its response. The method will populate request cookies from the context and\nupdate context cookies from the response. The method will automatically follow redirects. JSON objects can be\npassed directly to the request.\n\n**Usage**\n\n```js\nawait request.fetch('https://example.com/api/createBook', {\n method: 'post',\n data: {\n title: 'Book Title',\n author: 'John Doe',\n }\n});\n```\n\n```java\nMap data = new HashMap();\ndata.put(\"title\", \"Book Title\");\ndata.put(\"body\", \"John Doe\");\nrequest.fetch(\"https://example.com/api/createBook\", RequestOptions.create().setMethod(\"post\").setData(data));\n```\n\n```python\ndata = {\n \"title\": \"Book Title\",\n \"body\": \"John Doe\",\n}\napi_request_context.fetch(\"https://example.com/api/createBook\", method=\"post\", data=data)\n```\n\n```csharp\nvar data = new Dictionary() {\n { \"title\", \"Book Title\" },\n { \"body\", \"John Doe\" }\n};\nawait Request.FetchAsync(\"https://example.com/api/createBook\", new() { Method = \"post\", DataObject = data });\n```\n\nThe common way to send file(s) in the body of a request is to encode it as form fields with `multipart/form-data`\nencoding. You can achieve that with Playwright API like this:\n\n```js\n// Open file as a stream and pass it to the request:\nconst stream = fs.createReadStream('team.csv');\nawait request.fetch('https://example.com/api/uploadTeamList', {\n method: 'post',\n multipart: {\n fileField: stream\n }\n});\n\n// Or you can pass the file content directly as an object:\nawait request.fetch('https://example.com/api/uploadScript', {\n method: 'post',\n multipart: {\n fileField: {\n name: 'f.js',\n mimeType: 'text/javascript',\n buffer: Buffer.from('console.log(2022);')\n }\n }\n});\n```\n\n```java\n// Pass file path to the form data constructor:\nPath file = Paths.get(\"team.csv\");\nAPIResponse response = request.fetch(\"https://example.com/api/uploadTeamList\",\n RequestOptions.create().setMethod(\"post\").setMultipart(\n FormData.create().set(\"fileField\", file)));\n\n// Or you can pass the file content directly as FilePayload object:\nFilePayload filePayload = new FilePayload(\"f.js\", \"text/javascript\",\n \"console.log(2022);\".getBytes(StandardCharsets.UTF_8));\nAPIResponse response = request.fetch(\"https://example.com/api/uploadTeamList\",\n RequestOptions.create().setMethod(\"post\").setMultipart(\n FormData.create().set(\"fileField\", filePayload)));\n```\n\n```python\napi_request_context.fetch(\n \"https://example.com/api/uploadScrip'\",\n method=\"post\",\n multipart={\n \"fileField\": {\n \"name\": \"f.js\",\n \"mimeType\": \"text/javascript\",\n \"buffer\": b\"console.log(2022);\",\n },\n })\n```\n\n```csharp\nvar file = new FilePayload()\n{\n Name = \"f.js\",\n MimeType = \"text/javascript\",\n Buffer = System.Text.Encoding.UTF8.GetBytes(\"console.log(2022);\")\n};\nvar multipart = Context.APIRequest.CreateFormData();\nmultipart.Set(\"fileField\", file);\nawait Request.FetchAsync(\"https://example.com/api/uploadScript\", new() { Method = \"post\", Multipart = multipart });\n```\n", "async": true, "alias": "fetch", "overloadIndex": 0, @@ -8431,7 +9040,6 @@ ], "required": true, "comment": "Target URL or Request to get all parameters from.", - "deprecated": false, "async": false, "alias": "urlOrRequest", "overloadIndex": 0, @@ -8462,7 +9070,6 @@ ], "required": false, "comment": "Optional request parameters.", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -8510,12 +9117,11 @@ "spec": [ { "type": "text", - "text": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will be set to `application/octet-stream` if not explicitly set." + "text": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string↵and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will be↵set to `application/octet-stream` if not explicitly set." } ], "required": false, - "comment": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string and\n`content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will\nbe set to `application/octet-stream` if not explicitly set.", - "deprecated": false, + "comment": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string\nand `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type`\nheader will be set to `application/octet-stream` if not explicitly set.", "async": false, "alias": "data", "overloadIndex": 0, @@ -8543,12 +9149,11 @@ "spec": [ { "type": "text", - "text": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes." + "text": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned↵for all status codes." } ], "required": false, - "comment": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes.", - "deprecated": false, + "comment": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status\ncodes.", "async": false, "alias": "failOnStatusCode", "overloadIndex": 0, @@ -8594,12 +9199,11 @@ "spec": [ { "type": "text", - "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded` unless explicitly provided." + "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded`↵unless explicitly provided." } ], "required": false, - "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as\nthis request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent\nas this request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.", "async": false, "alias": "form", "overloadIndex": 0, @@ -8625,7 +9229,7 @@ "spec": [ { "type": "text", - "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded` unless explicitly provided." + "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded`↵unless explicitly provided." }, { "type": "text", @@ -8633,8 +9237,7 @@ } ], "required": false, - "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as\nthis request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent\nas this request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", "async": false, "alias": "form", "overloadIndex": 0, @@ -8670,12 +9273,11 @@ "spec": [ { "type": "text", - "text": "Allows to set HTTP headers." + "text": "Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by it." } ], "required": false, - "comment": "Allows to set HTTP headers.", - "deprecated": false, + "comment": "Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by\nit.", "async": false, "alias": "headers", "overloadIndex": 0, @@ -8708,12 +9310,43 @@ ], "required": false, "comment": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.", - "deprecated": false, "async": false, "alias": "ignoreHTTPSErrors", "overloadIndex": 0, "paramOrOption": null }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "python", + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.26", + "name": "maxRedirects", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded.↵Defaults to `20`. Pass `0` to not follow redirects." + } + ], + "required": false, + "comment": "Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is\nexceeded. Defaults to `20`. Pass `0` to not follow redirects.", + "async": false, + "alias": "maxRedirects", + "overloadIndex": 0, + "paramOrOption": null + }, { "kind": "property", "langs": { @@ -8736,12 +9369,11 @@ "spec": [ { "type": "text", - "text": "If set changes the fetch method (e.g. [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) or [POST](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST)). If not specified, GET method is used." + "text": "If set changes the fetch method (e.g. [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) or↵[POST](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST)). If not specified, GET method is used." } ], "required": false, "comment": "If set changes the fetch method (e.g. [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) or\n[POST](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST)). If not specified, GET method is used.", - "deprecated": false, "async": false, "alias": "method", "overloadIndex": 0, @@ -8782,7 +9414,6 @@ ], "required": true, "comment": "File name", - "deprecated": false, "async": false, "alias": "name", "overloadIndex": 0, @@ -8806,7 +9437,6 @@ ], "required": true, "comment": "File type", - "deprecated": false, "async": false, "alias": "mimeType", "overloadIndex": 0, @@ -8830,7 +9460,6 @@ ], "required": true, "comment": "File content", - "deprecated": false, "async": false, "alias": "buffer", "overloadIndex": 0, @@ -8877,7 +9506,6 @@ ], "required": true, "comment": "File name", - "deprecated": false, "async": false, "alias": "name", "overloadIndex": 0, @@ -8901,7 +9529,6 @@ ], "required": true, "comment": "File type", - "deprecated": false, "async": false, "alias": "mimeType", "overloadIndex": 0, @@ -8925,7 +9552,6 @@ ], "required": true, "comment": "File content", - "deprecated": false, "async": false, "alias": "buffer", "overloadIndex": 0, @@ -8941,12 +9567,11 @@ "spec": [ { "type": "text", - "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file name, mime-type and its content." + "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data`↵unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)↵or as file-like object containing file name, mime-type and its content." } ], "required": false, - "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request\nbody. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly\nprovided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)\nor as file-like object containing file name, mime-type and its content.", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this\nrequest body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless\nexplicitly provided. File values can be passed either as\n[`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file\nname, mime-type and its content.", "async": false, "alias": "multipart", "overloadIndex": 0, @@ -8972,7 +9597,7 @@ "spec": [ { "type": "text", - "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file name, mime-type and its content." + "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data`↵unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)↵or as file-like object containing file name, mime-type and its content." }, { "type": "text", @@ -8980,8 +9605,7 @@ } ], "required": false, - "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request\nbody. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly\nprovided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)\nor as file-like object containing file name, mime-type and its content.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this\nrequest body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless\nexplicitly provided. File values can be passed either as\n[`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file\nname, mime-type and its content.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", "async": false, "alias": "multipart", "overloadIndex": 0, @@ -9032,7 +9656,6 @@ ], "required": false, "comment": "Query parameters to be sent with the URL.", - "deprecated": false, "async": false, "alias": "params", "overloadIndex": 0, @@ -9071,7 +9694,6 @@ ], "required": false, "comment": "Query parameters to be sent with the URL.", - "deprecated": false, "async": false, "alias": "params", "overloadIndex": 0, @@ -9104,7 +9726,6 @@ ], "required": false, "comment": "Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.", - "deprecated": false, "async": false, "alias": "timeout", "overloadIndex": 0, @@ -9114,7 +9735,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -9135,12 +9755,63 @@ "spec": [ { "type": "text", - "text": "Sends HTTP(S) [GET](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET) request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects." + "text": "Sends HTTP(S) [GET](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET) request and returns its response.↵The method will populate request cookies from the context and update↵context cookies from the response. The method will automatically follow redirects." + }, + { + "type": "text", + "text": "**Usage**" + }, + { + "type": "text", + "text": "Request parameters can be configured with `params` option, they will be serialized into the URL search parameters:" + }, + { + "type": "code", + "lines": [ + "await request.get('https://example.com/api/getText', {", + " params: {", + " 'isbn': '1234',", + " 'page': 23,", + " }", + "});" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "request.get(\"https://example.com/api/getText\", RequestOptions.create()", + " .setQueryParam(\"isbn\", \"1234\")", + " .setQueryParam(\"page\", 23));" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "query_params = {", + " \"isbn\": \"1234\",", + " \"page\": \"23\"", + "}", + "api_request_context.get(\"https://example.com/api/getText\", params=query_params)" + ], + "codeLang": "python" + }, + { + "type": "code", + "lines": [ + "var params = new Dictionary()", + "{", + " { \"isbn\", \"1234\" },", + " { \"page\", 23 },", + "}", + "await request.GetAsync(\"https://example.com/api/getText\", new() { Params = params });" + ], + "codeLang": "csharp" } ], "required": true, - "comment": "Sends HTTP(S) [GET](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET) request and returns its response. The\nmethod will populate request cookies from the context and update context cookies from the response. The method will\nautomatically follow redirects.", - "deprecated": false, + "comment": "Sends HTTP(S) [GET](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET) request and returns its\nresponse. The method will populate request cookies from the context and update context cookies from the response.\nThe method will automatically follow redirects.\n\n**Usage**\n\nRequest parameters can be configured with `params` option, they will be serialized into the URL search parameters:\n\n```js\nawait request.get('https://example.com/api/getText', {\n params: {\n 'isbn': '1234',\n 'page': 23,\n }\n});\n```\n\n```java\nrequest.get(\"https://example.com/api/getText\", RequestOptions.create()\n .setQueryParam(\"isbn\", \"1234\")\n .setQueryParam(\"page\", 23));\n```\n\n```python\nquery_params = {\n \"isbn\": \"1234\",\n \"page\": \"23\"\n}\napi_request_context.get(\"https://example.com/api/getText\", params=query_params)\n```\n\n```csharp\nvar params = new Dictionary()\n{\n { \"isbn\", \"1234\" },\n { \"page\", 23 },\n}\nawait request.GetAsync(\"https://example.com/api/getText\", new() { Params = params });\n```\n", "async": true, "alias": "get", "overloadIndex": 0, @@ -9164,7 +9835,6 @@ ], "required": true, "comment": "Target URL.", - "deprecated": false, "async": false, "alias": "url", "overloadIndex": 0, @@ -9195,7 +9865,6 @@ ], "required": false, "comment": "Optional request parameters.", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -9210,6 +9879,49 @@ "type": { "name": "Object", "properties": [ + { + "kind": "property", + "langs": { + "only": [ + "js", + "python", + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.26", + "name": "data", + "type": { + "name": "", + "union": [ + { + "name": "string" + }, + { + "name": "Buffer" + }, + { + "name": "Serializable" + } + ], + "expression": "[string]|[Buffer]|[Serializable]" + }, + "spec": [ + { + "type": "text", + "text": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string↵and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will be↵set to `application/octet-stream` if not explicitly set." + } + ], + "required": false, + "comment": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string\nand `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type`\nheader will be set to `application/octet-stream` if not explicitly set.", + "async": false, + "alias": "data", + "overloadIndex": 0, + "paramOrOption": null + }, { "kind": "property", "langs": { @@ -9232,12 +9944,11 @@ "spec": [ { "type": "text", - "text": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes." + "text": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned↵for all status codes." } ], "required": false, - "comment": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes.", - "deprecated": false, + "comment": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status\ncodes.", "async": false, "alias": "failOnStatusCode", "overloadIndex": 0, @@ -9248,16 +9959,15 @@ "langs": { "only": [ "js", - "python", - "csharp" + "python" ], "aliases": {}, "types": {}, "overrides": {} }, "experimental": false, - "since": "v1.16", - "name": "headers", + "since": "v1.26", + "name": "form", "type": { "name": "Object", "templates": [ @@ -9265,22 +9975,32 @@ "name": "string" }, { - "name": "string" + "name": "", + "union": [ + { + "name": "string" + }, + { + "name": "float" + }, + { + "name": "boolean" + } + ] } ], - "expression": "[Object]<[string], [string]>" + "expression": "[Object]<[string], [string]|[float]|[boolean]>" }, "spec": [ { "type": "text", - "text": "Allows to set HTTP headers." + "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded`↵unless explicitly provided." } ], "required": false, - "comment": "Allows to set HTTP headers.", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent\nas this request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.", "async": false, - "alias": "headers", + "alias": "form", "overloadIndex": 0, "paramOrOption": null }, @@ -9288,8 +10008,6 @@ "kind": "property", "langs": { "only": [ - "js", - "python", "csharp" ], "aliases": {}, @@ -9297,74 +10015,26 @@ "overrides": {} }, "experimental": false, - "since": "v1.16", - "name": "ignoreHTTPSErrors", + "since": "v1.26", + "name": "form", "type": { - "name": "boolean", - "expression": "[boolean]" + "name": "FormData", + "expression": "[FormData]" }, "spec": [ { "type": "text", - "text": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`." - } - ], - "required": false, - "comment": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.", - "deprecated": false, - "async": false, - "alias": "ignoreHTTPSErrors", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": { - "only": [ - "js", - "python" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.16", - "name": "params", - "type": { - "name": "Object", - "templates": [ - { - "name": "string" - }, - { - "name": "", - "union": [ - { - "name": "string" - }, - { - "name": "float" - }, - { - "name": "boolean" - } - ] - } - ], - "expression": "[Object]<[string], [string]|[float]|[boolean]>" - }, - "spec": [ + "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded`↵unless explicitly provided." + }, { "type": "text", - "text": "Query parameters to be sent with the URL." + "text": "An instance of `FormData` can be created via [`method: APIRequestContext.createFormData`]." } ], "required": false, - "comment": "Query parameters to be sent with the URL.", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent\nas this request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", "async": false, - "alias": "params", + "alias": "form", "overloadIndex": 0, "paramOrOption": null }, @@ -9372,6 +10042,8 @@ "kind": "property", "langs": { "only": [ + "js", + "python", "csharp" ], "aliases": {}, @@ -9380,7 +10052,7 @@ }, "experimental": false, "since": "v1.16", - "name": "params", + "name": "headers", "type": { "name": "Object", "templates": [ @@ -9388,22 +10060,21 @@ "name": "string" }, { - "name": "Serializable" + "name": "string" } ], - "expression": "[Object]<[string], [Serializable]>" + "expression": "[Object]<[string], [string]>" }, "spec": [ { "type": "text", - "text": "Query parameters to be sent with the URL." + "text": "Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by it." } ], "required": false, - "comment": "Query parameters to be sent with the URL.", - "deprecated": false, + "comment": "Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by\nit.", "async": false, - "alias": "params", + "alias": "headers", "overloadIndex": 0, "paramOrOption": null }, @@ -9421,125 +10092,24 @@ }, "experimental": false, "since": "v1.16", - "name": "timeout", + "name": "ignoreHTTPSErrors", "type": { - "name": "float", - "expression": "[float]" + "name": "boolean", + "expression": "[boolean]" }, "spec": [ { "type": "text", - "text": "Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout." + "text": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`." } ], "required": false, - "comment": "Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.", - "deprecated": false, + "comment": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.", "async": false, - "alias": "timeout", + "alias": "ignoreHTTPSErrors", "overloadIndex": 0, "paramOrOption": null - } - ] - }, - "required": false, - "comment": "", - "deprecated": false, - "async": false, - "alias": "options", - "overloadIndex": 0, - "paramOrOption": null - } - ] - }, - { - "kind": "method", - "langs": {}, - "experimental": false, - "since": "v1.16", - "name": "head", - "type": { - "name": "APIResponse", - "expression": "[APIResponse]" - }, - "spec": [ - { - "type": "text", - "text": "Sends HTTP(S) [HEAD](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD) request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects." - } - ], - "required": true, - "comment": "Sends HTTP(S) [HEAD](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD) request and returns its response.\nThe method will populate request cookies from the context and update context cookies from the response. The method will\nautomatically follow redirects.", - "deprecated": false, - "async": true, - "alias": "head", - "overloadIndex": 0, - "paramOrOption": null, - "args": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.16", - "name": "url", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "Target URL." - } - ], - "required": true, - "comment": "Target URL.", - "deprecated": false, - "async": false, - "alias": "url", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": { - "only": [ - "java" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.18", - "name": "params", - "type": { - "name": "RequestOptions", - "expression": "[RequestOptions]" - }, - "spec": [ - { - "type": "text", - "text": "Optional request parameters." - } - ], - "required": false, - "comment": "Optional request parameters.", - "deprecated": false, - "async": false, - "alias": "options", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "options", - "type": { - "name": "Object", - "properties": [ + }, { "kind": "property", "langs": { @@ -9553,23 +10123,22 @@ "overrides": {} }, "experimental": false, - "since": "v1.16", - "name": "failOnStatusCode", + "since": "v1.26", + "name": "maxRedirects", "type": { - "name": "boolean", - "expression": "[boolean]" + "name": "int", + "expression": "[int]" }, "spec": [ { "type": "text", - "text": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes." + "text": "Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded.↵Defaults to `20`. Pass `0` to not follow redirects." } ], "required": false, - "comment": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes.", - "deprecated": false, + "comment": "Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is\nexceeded. Defaults to `20`. Pass `0` to not follow redirects.", "async": false, - "alias": "failOnStatusCode", + "alias": "maxRedirects", "overloadIndex": 0, "paramOrOption": null }, @@ -9578,39 +10147,196 @@ "langs": { "only": [ "js", - "python", - "csharp" + "python" ], "aliases": {}, "types": {}, "overrides": {} }, "experimental": false, - "since": "v1.16", - "name": "headers", + "since": "v1.26", + "name": "multipart", "type": { "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "name", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "File name" + } + ], + "required": true, + "comment": "File name", + "async": false, + "alias": "name", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "mimeType", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "File type" + } + ], + "required": true, + "comment": "File type", + "async": false, + "alias": "mimeType", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "buffer", + "type": { + "name": "Buffer", + "expression": "[Buffer]" + }, + "spec": [ + { + "type": "text", + "text": "File content" + } + ], + "required": true, + "comment": "File content", + "async": false, + "alias": "buffer", + "overloadIndex": 0, + "paramOrOption": null + } + ], "templates": [ { "name": "string" }, { - "name": "string" + "name": "", + "union": [ + { + "name": "string" + }, + { + "name": "float" + }, + { + "name": "boolean" + }, + { + "name": "ReadStream" + }, + { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "name", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "File name" + } + ], + "required": true, + "comment": "File name", + "async": false, + "alias": "name", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "mimeType", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "File type" + } + ], + "required": true, + "comment": "File type", + "async": false, + "alias": "mimeType", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "buffer", + "type": { + "name": "Buffer", + "expression": "[Buffer]" + }, + "spec": [ + { + "type": "text", + "text": "File content" + } + ], + "required": true, + "comment": "File content", + "async": false, + "alias": "buffer", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ] } ], - "expression": "[Object]<[string], [string]>" + "expression": "[Object]<[string], [string]|[float]|[boolean]|[ReadStream]|[Object]>" }, "spec": [ { "type": "text", - "text": "Allows to set HTTP headers." + "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data`↵unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)↵or as file-like object containing file name, mime-type and its content." } ], "required": false, - "comment": "Allows to set HTTP headers.", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this\nrequest body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless\nexplicitly provided. File values can be passed either as\n[`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file\nname, mime-type and its content.", "async": false, - "alias": "headers", + "alias": "multipart", "overloadIndex": 0, "paramOrOption": null }, @@ -9618,8 +10344,6 @@ "kind": "property", "langs": { "only": [ - "js", - "python", "csharp" ], "aliases": {}, @@ -9627,23 +10351,26 @@ "overrides": {} }, "experimental": false, - "since": "v1.16", - "name": "ignoreHTTPSErrors", + "since": "v1.26", + "name": "multipart", "type": { - "name": "boolean", - "expression": "[boolean]" + "name": "FormData", + "expression": "[FormData]" }, "spec": [ { "type": "text", - "text": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`." + "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data`↵unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)↵or as file-like object containing file name, mime-type and its content." + }, + { + "type": "text", + "text": "An instance of `FormData` can be created via [`method: APIRequestContext.createFormData`]." } ], "required": false, - "comment": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this\nrequest body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless\nexplicitly provided. File values can be passed either as\n[`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file\nname, mime-type and its content.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", "async": false, - "alias": "ignoreHTTPSErrors", + "alias": "multipart", "overloadIndex": 0, "paramOrOption": null }, @@ -9692,7 +10419,6 @@ ], "required": false, "comment": "Query parameters to be sent with the URL.", - "deprecated": false, "async": false, "alias": "params", "overloadIndex": 0, @@ -9731,7 +10457,6 @@ ], "required": false, "comment": "Query parameters to be sent with the URL.", - "deprecated": false, "async": false, "alias": "params", "overloadIndex": 0, @@ -9764,7 +10489,6 @@ ], "required": false, "comment": "Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.", - "deprecated": false, "async": false, "alias": "timeout", "overloadIndex": 0, @@ -9774,7 +10498,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -9787,7 +10510,7 @@ "langs": {}, "experimental": false, "since": "v1.16", - "name": "patch", + "name": "head", "type": { "name": "APIResponse", "expression": "[APIResponse]" @@ -9795,14 +10518,13 @@ "spec": [ { "type": "text", - "text": "Sends HTTP(S) [PATCH](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH) request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects." + "text": "Sends HTTP(S) [HEAD](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD) request and returns its response.↵The method will populate request cookies from the context and update↵context cookies from the response. The method will automatically follow redirects." } ], "required": true, - "comment": "Sends HTTP(S) [PATCH](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH) request and returns its response.\nThe method will populate request cookies from the context and update context cookies from the response. The method will\nautomatically follow redirects.", - "deprecated": false, + "comment": "Sends HTTP(S) [HEAD](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD) request and returns its\nresponse. The method will populate request cookies from the context and update context cookies from the response.\nThe method will automatically follow redirects.", "async": true, - "alias": "patch", + "alias": "head", "overloadIndex": 0, "paramOrOption": null, "args": [ @@ -9824,7 +10546,6 @@ ], "required": true, "comment": "Target URL.", - "deprecated": false, "async": false, "alias": "url", "overloadIndex": 0, @@ -9855,7 +10576,6 @@ ], "required": false, "comment": "Optional request parameters.", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -9883,7 +10603,7 @@ "overrides": {} }, "experimental": false, - "since": "v1.16", + "since": "v1.26", "name": "data", "type": { "name": "", @@ -9903,12 +10623,11 @@ "spec": [ { "type": "text", - "text": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will be set to `application/octet-stream` if not explicitly set." + "text": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string↵and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will be↵set to `application/octet-stream` if not explicitly set." } ], "required": false, - "comment": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string and\n`content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will\nbe set to `application/octet-stream` if not explicitly set.", - "deprecated": false, + "comment": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string\nand `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type`\nheader will be set to `application/octet-stream` if not explicitly set.", "async": false, "alias": "data", "overloadIndex": 0, @@ -9936,12 +10655,11 @@ "spec": [ { "type": "text", - "text": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes." + "text": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned↵for all status codes." } ], "required": false, - "comment": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes.", - "deprecated": false, + "comment": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status\ncodes.", "async": false, "alias": "failOnStatusCode", "overloadIndex": 0, @@ -9959,7 +10677,7 @@ "overrides": {} }, "experimental": false, - "since": "v1.16", + "since": "v1.26", "name": "form", "type": { "name": "Object", @@ -9987,12 +10705,11 @@ "spec": [ { "type": "text", - "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded` unless explicitly provided." + "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded`↵unless explicitly provided." } ], "required": false, - "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as\nthis request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent\nas this request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.", "async": false, "alias": "form", "overloadIndex": 0, @@ -10009,7 +10726,7 @@ "overrides": {} }, "experimental": false, - "since": "v1.16", + "since": "v1.26", "name": "form", "type": { "name": "FormData", @@ -10018,7 +10735,7 @@ "spec": [ { "type": "text", - "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded` unless explicitly provided." + "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded`↵unless explicitly provided." }, { "type": "text", @@ -10026,8 +10743,7 @@ } ], "required": false, - "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as\nthis request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent\nas this request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", "async": false, "alias": "form", "overloadIndex": 0, @@ -10063,12 +10779,11 @@ "spec": [ { "type": "text", - "text": "Allows to set HTTP headers." + "text": "Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by it." } ], "required": false, - "comment": "Allows to set HTTP headers.", - "deprecated": false, + "comment": "Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by\nit.", "async": false, "alias": "headers", "overloadIndex": 0, @@ -10101,12 +10816,43 @@ ], "required": false, "comment": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.", - "deprecated": false, "async": false, "alias": "ignoreHTTPSErrors", "overloadIndex": 0, "paramOrOption": null }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "python", + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.26", + "name": "maxRedirects", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded.↵Defaults to `20`. Pass `0` to not follow redirects." + } + ], + "required": false, + "comment": "Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is\nexceeded. Defaults to `20`. Pass `0` to not follow redirects.", + "async": false, + "alias": "maxRedirects", + "overloadIndex": 0, + "paramOrOption": null + }, { "kind": "property", "langs": { @@ -10119,7 +10865,7 @@ "overrides": {} }, "experimental": false, - "since": "v1.16", + "since": "v1.26", "name": "multipart", "type": { "name": "Object", @@ -10142,7 +10888,6 @@ ], "required": true, "comment": "File name", - "deprecated": false, "async": false, "alias": "name", "overloadIndex": 0, @@ -10166,7 +10911,6 @@ ], "required": true, "comment": "File type", - "deprecated": false, "async": false, "alias": "mimeType", "overloadIndex": 0, @@ -10190,7 +10934,6 @@ ], "required": true, "comment": "File content", - "deprecated": false, "async": false, "alias": "buffer", "overloadIndex": 0, @@ -10237,7 +10980,6 @@ ], "required": true, "comment": "File name", - "deprecated": false, "async": false, "alias": "name", "overloadIndex": 0, @@ -10261,7 +11003,6 @@ ], "required": true, "comment": "File type", - "deprecated": false, "async": false, "alias": "mimeType", "overloadIndex": 0, @@ -10285,7 +11026,6 @@ ], "required": true, "comment": "File content", - "deprecated": false, "async": false, "alias": "buffer", "overloadIndex": 0, @@ -10301,12 +11041,11 @@ "spec": [ { "type": "text", - "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file name, mime-type and its content." + "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data`↵unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)↵or as file-like object containing file name, mime-type and its content." } ], "required": false, - "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request\nbody. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly\nprovided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)\nor as file-like object containing file name, mime-type and its content.", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this\nrequest body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless\nexplicitly provided. File values can be passed either as\n[`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file\nname, mime-type and its content.", "async": false, "alias": "multipart", "overloadIndex": 0, @@ -10323,7 +11062,7 @@ "overrides": {} }, "experimental": false, - "since": "v1.16", + "since": "v1.26", "name": "multipart", "type": { "name": "FormData", @@ -10332,7 +11071,7 @@ "spec": [ { "type": "text", - "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file name, mime-type and its content." + "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data`↵unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)↵or as file-like object containing file name, mime-type and its content." }, { "type": "text", @@ -10340,8 +11079,7 @@ } ], "required": false, - "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request\nbody. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly\nprovided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)\nor as file-like object containing file name, mime-type and its content.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this\nrequest body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless\nexplicitly provided. File values can be passed either as\n[`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file\nname, mime-type and its content.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", "async": false, "alias": "multipart", "overloadIndex": 0, @@ -10392,7 +11130,6 @@ ], "required": false, "comment": "Query parameters to be sent with the URL.", - "deprecated": false, "async": false, "alias": "params", "overloadIndex": 0, @@ -10431,7 +11168,6 @@ ], "required": false, "comment": "Query parameters to be sent with the URL.", - "deprecated": false, "async": false, "alias": "params", "overloadIndex": 0, @@ -10464,7 +11200,6 @@ ], "required": false, "comment": "Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.", - "deprecated": false, "async": false, "alias": "timeout", "overloadIndex": 0, @@ -10474,7 +11209,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -10487,7 +11221,7 @@ "langs": {}, "experimental": false, "since": "v1.16", - "name": "post", + "name": "patch", "type": { "name": "APIResponse", "expression": "[APIResponse]" @@ -10495,14 +11229,13 @@ "spec": [ { "type": "text", - "text": "Sends HTTP(S) [POST](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects." + "text": "Sends HTTP(S) [PATCH](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH) request and returns its response.↵The method will populate request cookies from the context and update↵context cookies from the response. The method will automatically follow redirects." } ], "required": true, - "comment": "Sends HTTP(S) [POST](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) request and returns its response.\nThe method will populate request cookies from the context and update context cookies from the response. The method will\nautomatically follow redirects.", - "deprecated": false, + "comment": "Sends HTTP(S) [PATCH](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH) request and returns its\nresponse. The method will populate request cookies from the context and update context cookies from the response.\nThe method will automatically follow redirects.", "async": true, - "alias": "post", + "alias": "patch", "overloadIndex": 0, "paramOrOption": null, "args": [ @@ -10524,7 +11257,6 @@ ], "required": true, "comment": "Target URL.", - "deprecated": false, "async": false, "alias": "url", "overloadIndex": 0, @@ -10555,7 +11287,6 @@ ], "required": false, "comment": "Optional request parameters.", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -10603,12 +11334,11 @@ "spec": [ { "type": "text", - "text": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will be set to `application/octet-stream` if not explicitly set." + "text": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string↵and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will be↵set to `application/octet-stream` if not explicitly set." } ], "required": false, - "comment": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string and\n`content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will\nbe set to `application/octet-stream` if not explicitly set.", - "deprecated": false, + "comment": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string\nand `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type`\nheader will be set to `application/octet-stream` if not explicitly set.", "async": false, "alias": "data", "overloadIndex": 0, @@ -10636,12 +11366,11 @@ "spec": [ { "type": "text", - "text": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes." + "text": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned↵for all status codes." } ], "required": false, - "comment": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes.", - "deprecated": false, + "comment": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status\ncodes.", "async": false, "alias": "failOnStatusCode", "overloadIndex": 0, @@ -10687,12 +11416,11 @@ "spec": [ { "type": "text", - "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded` unless explicitly provided." + "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded`↵unless explicitly provided." } ], "required": false, - "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as\nthis request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent\nas this request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.", "async": false, "alias": "form", "overloadIndex": 0, @@ -10718,7 +11446,7 @@ "spec": [ { "type": "text", - "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded` unless explicitly provided." + "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded`↵unless explicitly provided." }, { "type": "text", @@ -10726,8 +11454,7 @@ } ], "required": false, - "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as\nthis request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent\nas this request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", "async": false, "alias": "form", "overloadIndex": 0, @@ -10763,12 +11490,11 @@ "spec": [ { "type": "text", - "text": "Allows to set HTTP headers." + "text": "Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by it." } ], "required": false, - "comment": "Allows to set HTTP headers.", - "deprecated": false, + "comment": "Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by\nit.", "async": false, "alias": "headers", "overloadIndex": 0, @@ -10801,12 +11527,43 @@ ], "required": false, "comment": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.", - "deprecated": false, "async": false, "alias": "ignoreHTTPSErrors", "overloadIndex": 0, "paramOrOption": null }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "python", + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.26", + "name": "maxRedirects", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded.↵Defaults to `20`. Pass `0` to not follow redirects." + } + ], + "required": false, + "comment": "Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is\nexceeded. Defaults to `20`. Pass `0` to not follow redirects.", + "async": false, + "alias": "maxRedirects", + "overloadIndex": 0, + "paramOrOption": null + }, { "kind": "property", "langs": { @@ -10842,7 +11599,6 @@ ], "required": true, "comment": "File name", - "deprecated": false, "async": false, "alias": "name", "overloadIndex": 0, @@ -10866,7 +11622,6 @@ ], "required": true, "comment": "File type", - "deprecated": false, "async": false, "alias": "mimeType", "overloadIndex": 0, @@ -10890,7 +11645,6 @@ ], "required": true, "comment": "File content", - "deprecated": false, "async": false, "alias": "buffer", "overloadIndex": 0, @@ -10937,7 +11691,6 @@ ], "required": true, "comment": "File name", - "deprecated": false, "async": false, "alias": "name", "overloadIndex": 0, @@ -10961,7 +11714,6 @@ ], "required": true, "comment": "File type", - "deprecated": false, "async": false, "alias": "mimeType", "overloadIndex": 0, @@ -10985,7 +11737,6 @@ ], "required": true, "comment": "File content", - "deprecated": false, "async": false, "alias": "buffer", "overloadIndex": 0, @@ -11001,12 +11752,11 @@ "spec": [ { "type": "text", - "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file name, mime-type and its content." + "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data`↵unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)↵or as file-like object containing file name, mime-type and its content." } ], "required": false, - "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request\nbody. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly\nprovided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)\nor as file-like object containing file name, mime-type and its content.", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this\nrequest body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless\nexplicitly provided. File values can be passed either as\n[`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file\nname, mime-type and its content.", "async": false, "alias": "multipart", "overloadIndex": 0, @@ -11032,7 +11782,7 @@ "spec": [ { "type": "text", - "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file name, mime-type and its content." + "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data`↵unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)↵or as file-like object containing file name, mime-type and its content." }, { "type": "text", @@ -11040,8 +11790,7 @@ } ], "required": false, - "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request\nbody. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly\nprovided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)\nor as file-like object containing file name, mime-type and its content.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this\nrequest body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless\nexplicitly provided. File values can be passed either as\n[`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file\nname, mime-type and its content.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", "async": false, "alias": "multipart", "overloadIndex": 0, @@ -11092,7 +11841,6 @@ ], "required": false, "comment": "Query parameters to be sent with the URL.", - "deprecated": false, "async": false, "alias": "params", "overloadIndex": 0, @@ -11131,7 +11879,6 @@ ], "required": false, "comment": "Query parameters to be sent with the URL.", - "deprecated": false, "async": false, "alias": "params", "overloadIndex": 0, @@ -11164,7 +11911,6 @@ ], "required": false, "comment": "Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.", - "deprecated": false, "async": false, "alias": "timeout", "overloadIndex": 0, @@ -11174,7 +11920,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -11187,7 +11932,7 @@ "langs": {}, "experimental": false, "since": "v1.16", - "name": "put", + "name": "post", "type": { "name": "APIResponse", "expression": "[APIResponse]" @@ -11195,14 +11940,187 @@ "spec": [ { "type": "text", - "text": "Sends HTTP(S) [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects." + "text": "Sends HTTP(S) [POST](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) request and returns its response.↵The method will populate request cookies from the context and update↵context cookies from the response. The method will automatically follow redirects." + }, + { + "type": "text", + "text": "**Usage**" + }, + { + "type": "text", + "text": "JSON objects can be passed directly to the request:" + }, + { + "type": "code", + "lines": [ + "await request.post('https://example.com/api/createBook', {", + " data: {", + " title: 'Book Title',", + " author: 'John Doe',", + " }", + "});" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "Map data = new HashMap();", + "data.put(\"title\", \"Book Title\");", + "data.put(\"body\", \"John Doe\");", + "request.post(\"https://example.com/api/createBook\", RequestOptions.create().setData(data));" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "data = {", + " \"title\": \"Book Title\",", + " \"body\": \"John Doe\",", + "}", + "api_request_context.post(\"https://example.com/api/createBook\", data=data)" + ], + "codeLang": "python" + }, + { + "type": "code", + "lines": [ + "var data = new Dictionary() {", + " { \"firstNam\", \"John\" },", + " { \"lastName\", \"Doe\" }", + "};", + "await request.PostAsync(\"https://example.com/api/createBook\", new() { DataObject = data });" + ], + "codeLang": "csharp" + }, + { + "type": "text", + "text": "To send form data to the server use `form` option. Its value will be encoded into the request body with `application/x-www-form-urlencoded` encoding (see below how to use `multipart/form-data` form encoding to send files):" + }, + { + "type": "code", + "lines": [ + "await request.post('https://example.com/api/findBook', {", + " form: {", + " title: 'Book Title',", + " author: 'John Doe',", + " }", + "});" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "request.post(\"https://example.com/api/findBook\", RequestOptions.create().setForm(", + " FormData.create().set(\"title\", \"Book Title\").set(\"body\", \"John Doe\")", + "));" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "formData = {", + " \"title\": \"Book Title\",", + " \"body\": \"John Doe\",", + "}", + "api_request_context.post(\"https://example.com/api/findBook\", form=formData)" + ], + "codeLang": "python" + }, + { + "type": "code", + "lines": [ + "var formData = Context.APIRequest.CreateFormData();", + "formData.Set(\"title\", \"Book Title\");", + "formData.Set(\"body\", \"John Doe\");", + "await request.PostAsync(\"https://example.com/api/findBook\", new() { Form = formData });" + ], + "codeLang": "csharp" + }, + { + "type": "text", + "text": "The common way to send file(s) in the body of a request is to upload them as form fields with `multipart/form-data` encoding. You can achieve that with Playwright API like this:" + }, + { + "type": "code", + "lines": [ + "// Open file as a stream and pass it to the request:", + "const stream = fs.createReadStream('team.csv');", + "await request.post('https://example.com/api/uploadTeamList', {", + " multipart: {", + " fileField: stream", + " }", + "});", + "", + "// Or you can pass the file content directly as an object:", + "await request.post('https://example.com/api/uploadScript', {", + " multipart: {", + " fileField: {", + " name: 'f.js',", + " mimeType: 'text/javascript',", + " buffer: Buffer.from('console.log(2022);')", + " }", + " }", + "});" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "// Pass file path to the form data constructor:", + "Path file = Paths.get(\"team.csv\");", + "APIResponse response = request.post(\"https://example.com/api/uploadTeamList\",", + " RequestOptions.create().setMultipart(", + " FormData.create().set(\"fileField\", file)));", + "", + "// Or you can pass the file content directly as FilePayload object:", + "FilePayload filePayload = new FilePayload(\"f.js\", \"text/javascript\",", + " \"console.log(2022);\".getBytes(StandardCharsets.UTF_8));", + "APIResponse response = request.post(\"https://example.com/api/uploadTeamList\",", + " RequestOptions.create().setMultipart(", + " FormData.create().set(\"fileField\", filePayload)));" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "api_request_context.post(", + " \"https://example.com/api/uploadScrip'\",", + " multipart={", + " \"fileField\": {", + " \"name\": \"f.js\",", + " \"mimeType\": \"text/javascript\",", + " \"buffer\": b\"console.log(2022);\",", + " },", + " })" + ], + "codeLang": "python" + }, + { + "type": "code", + "lines": [ + "var file = new FilePayload()", + "{", + " Name = \"f.js\",", + " MimeType = \"text/javascript\",", + " Buffer = System.Text.Encoding.UTF8.GetBytes(\"console.log(2022);\")", + "};", + "var multipart = Context.APIRequest.CreateFormData();", + "multipart.Set(\"fileField\", file);", + "await request.PostAsync(\"https://example.com/api/uploadScript\", new() { Multipart = multipart });" + ], + "codeLang": "csharp" } ], "required": true, - "comment": "Sends HTTP(S) [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) request and returns its response. The\nmethod will populate request cookies from the context and update context cookies from the response. The method will\nautomatically follow redirects.", - "deprecated": false, + "comment": "Sends HTTP(S) [POST](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) request and returns its\nresponse. The method will populate request cookies from the context and update context cookies from the response.\nThe method will automatically follow redirects.\n\n**Usage**\n\nJSON objects can be passed directly to the request:\n\n```js\nawait request.post('https://example.com/api/createBook', {\n data: {\n title: 'Book Title',\n author: 'John Doe',\n }\n});\n```\n\n```java\nMap data = new HashMap();\ndata.put(\"title\", \"Book Title\");\ndata.put(\"body\", \"John Doe\");\nrequest.post(\"https://example.com/api/createBook\", RequestOptions.create().setData(data));\n```\n\n```python\ndata = {\n \"title\": \"Book Title\",\n \"body\": \"John Doe\",\n}\napi_request_context.post(\"https://example.com/api/createBook\", data=data)\n```\n\n```csharp\nvar data = new Dictionary() {\n { \"firstNam\", \"John\" },\n { \"lastName\", \"Doe\" }\n};\nawait request.PostAsync(\"https://example.com/api/createBook\", new() { DataObject = data });\n```\n\nTo send form data to the server use `form` option. Its value will be encoded into the request body with\n`application/x-www-form-urlencoded` encoding (see below how to use `multipart/form-data` form encoding to send\nfiles):\n\n```js\nawait request.post('https://example.com/api/findBook', {\n form: {\n title: 'Book Title',\n author: 'John Doe',\n }\n});\n```\n\n```java\nrequest.post(\"https://example.com/api/findBook\", RequestOptions.create().setForm(\n FormData.create().set(\"title\", \"Book Title\").set(\"body\", \"John Doe\")\n));\n```\n\n```python\nformData = {\n \"title\": \"Book Title\",\n \"body\": \"John Doe\",\n}\napi_request_context.post(\"https://example.com/api/findBook\", form=formData)\n```\n\n```csharp\nvar formData = Context.APIRequest.CreateFormData();\nformData.Set(\"title\", \"Book Title\");\nformData.Set(\"body\", \"John Doe\");\nawait request.PostAsync(\"https://example.com/api/findBook\", new() { Form = formData });\n```\n\nThe common way to send file(s) in the body of a request is to upload them as form fields with `multipart/form-data`\nencoding. You can achieve that with Playwright API like this:\n\n```js\n// Open file as a stream and pass it to the request:\nconst stream = fs.createReadStream('team.csv');\nawait request.post('https://example.com/api/uploadTeamList', {\n multipart: {\n fileField: stream\n }\n});\n\n// Or you can pass the file content directly as an object:\nawait request.post('https://example.com/api/uploadScript', {\n multipart: {\n fileField: {\n name: 'f.js',\n mimeType: 'text/javascript',\n buffer: Buffer.from('console.log(2022);')\n }\n }\n});\n```\n\n```java\n// Pass file path to the form data constructor:\nPath file = Paths.get(\"team.csv\");\nAPIResponse response = request.post(\"https://example.com/api/uploadTeamList\",\n RequestOptions.create().setMultipart(\n FormData.create().set(\"fileField\", file)));\n\n// Or you can pass the file content directly as FilePayload object:\nFilePayload filePayload = new FilePayload(\"f.js\", \"text/javascript\",\n \"console.log(2022);\".getBytes(StandardCharsets.UTF_8));\nAPIResponse response = request.post(\"https://example.com/api/uploadTeamList\",\n RequestOptions.create().setMultipart(\n FormData.create().set(\"fileField\", filePayload)));\n```\n\n```python\napi_request_context.post(\n \"https://example.com/api/uploadScrip'\",\n multipart={\n \"fileField\": {\n \"name\": \"f.js\",\n \"mimeType\": \"text/javascript\",\n \"buffer\": b\"console.log(2022);\",\n },\n })\n```\n\n```csharp\nvar file = new FilePayload()\n{\n Name = \"f.js\",\n MimeType = \"text/javascript\",\n Buffer = System.Text.Encoding.UTF8.GetBytes(\"console.log(2022);\")\n};\nvar multipart = Context.APIRequest.CreateFormData();\nmultipart.Set(\"fileField\", file);\nawait request.PostAsync(\"https://example.com/api/uploadScript\", new() { Multipart = multipart });\n```\n", "async": true, - "alias": "put", + "alias": "post", "overloadIndex": 0, "paramOrOption": null, "args": [ @@ -11224,7 +12142,6 @@ ], "required": true, "comment": "Target URL.", - "deprecated": false, "async": false, "alias": "url", "overloadIndex": 0, @@ -11255,7 +12172,6 @@ ], "required": false, "comment": "Optional request parameters.", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -11303,12 +12219,11 @@ "spec": [ { "type": "text", - "text": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will be set to `application/octet-stream` if not explicitly set." + "text": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string↵and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will be↵set to `application/octet-stream` if not explicitly set." } ], "required": false, - "comment": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string and\n`content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will\nbe set to `application/octet-stream` if not explicitly set.", - "deprecated": false, + "comment": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string\nand `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type`\nheader will be set to `application/octet-stream` if not explicitly set.", "async": false, "alias": "data", "overloadIndex": 0, @@ -11336,12 +12251,11 @@ "spec": [ { "type": "text", - "text": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes." + "text": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned↵for all status codes." } ], "required": false, - "comment": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes.", - "deprecated": false, + "comment": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status\ncodes.", "async": false, "alias": "failOnStatusCode", "overloadIndex": 0, @@ -11387,12 +12301,11 @@ "spec": [ { "type": "text", - "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded` unless explicitly provided." + "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded`↵unless explicitly provided." } ], "required": false, - "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as\nthis request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent\nas this request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.", "async": false, "alias": "form", "overloadIndex": 0, @@ -11418,7 +12331,7 @@ "spec": [ { "type": "text", - "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded` unless explicitly provided." + "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded`↵unless explicitly provided." }, { "type": "text", @@ -11426,8 +12339,7 @@ } ], "required": false, - "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as\nthis request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent\nas this request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", "async": false, "alias": "form", "overloadIndex": 0, @@ -11463,12 +12375,11 @@ "spec": [ { "type": "text", - "text": "Allows to set HTTP headers." + "text": "Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by it." } ], "required": false, - "comment": "Allows to set HTTP headers.", - "deprecated": false, + "comment": "Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by\nit.", "async": false, "alias": "headers", "overloadIndex": 0, @@ -11501,12 +12412,43 @@ ], "required": false, "comment": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.", - "deprecated": false, "async": false, "alias": "ignoreHTTPSErrors", "overloadIndex": 0, "paramOrOption": null }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "python", + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.26", + "name": "maxRedirects", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded.↵Defaults to `20`. Pass `0` to not follow redirects." + } + ], + "required": false, + "comment": "Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is\nexceeded. Defaults to `20`. Pass `0` to not follow redirects.", + "async": false, + "alias": "maxRedirects", + "overloadIndex": 0, + "paramOrOption": null + }, { "kind": "property", "langs": { @@ -11542,7 +12484,6 @@ ], "required": true, "comment": "File name", - "deprecated": false, "async": false, "alias": "name", "overloadIndex": 0, @@ -11566,7 +12507,6 @@ ], "required": true, "comment": "File type", - "deprecated": false, "async": false, "alias": "mimeType", "overloadIndex": 0, @@ -11590,7 +12530,6 @@ ], "required": true, "comment": "File content", - "deprecated": false, "async": false, "alias": "buffer", "overloadIndex": 0, @@ -11637,7 +12576,6 @@ ], "required": true, "comment": "File name", - "deprecated": false, "async": false, "alias": "name", "overloadIndex": 0, @@ -11661,7 +12599,6 @@ ], "required": true, "comment": "File type", - "deprecated": false, "async": false, "alias": "mimeType", "overloadIndex": 0, @@ -11685,7 +12622,6 @@ ], "required": true, "comment": "File content", - "deprecated": false, "async": false, "alias": "buffer", "overloadIndex": 0, @@ -11701,12 +12637,11 @@ "spec": [ { "type": "text", - "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file name, mime-type and its content." + "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data`↵unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)↵or as file-like object containing file name, mime-type and its content." } ], "required": false, - "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request\nbody. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly\nprovided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)\nor as file-like object containing file name, mime-type and its content.", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this\nrequest body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless\nexplicitly provided. File values can be passed either as\n[`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file\nname, mime-type and its content.", "async": false, "alias": "multipart", "overloadIndex": 0, @@ -11732,7 +12667,7 @@ "spec": [ { "type": "text", - "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file name, mime-type and its content." + "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data`↵unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)↵or as file-like object containing file name, mime-type and its content." }, { "type": "text", @@ -11740,8 +12675,7 @@ } ], "required": false, - "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request\nbody. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly\nprovided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)\nor as file-like object containing file name, mime-type and its content.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this\nrequest body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless\nexplicitly provided. File values can be passed either as\n[`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file\nname, mime-type and its content.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", "async": false, "alias": "multipart", "overloadIndex": 0, @@ -11792,7 +12726,6 @@ ], "required": false, "comment": "Query parameters to be sent with the URL.", - "deprecated": false, "async": false, "alias": "params", "overloadIndex": 0, @@ -11831,7 +12764,6 @@ ], "required": false, "comment": "Query parameters to be sent with the URL.", - "deprecated": false, "async": false, "alias": "params", "overloadIndex": 0, @@ -11864,7 +12796,6 @@ ], "required": false, "comment": "Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.", - "deprecated": false, "async": false, "alias": "timeout", "overloadIndex": 0, @@ -11874,7 +12805,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -11884,201 +12814,389 @@ }, { "kind": "method", - "langs": { - "types": { - "java": { - "name": "string", - "expression": "[string]" - }, - "csharp": { - "name": "string", - "expression": "[string]" - } - } - }, + "langs": {}, "experimental": false, "since": "v1.16", - "name": "storageState", + "name": "put", "type": { - "name": "Object", - "properties": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "cookies", - "type": { - "name": "Array", - "templates": [ - { - "name": "Object", - "properties": [ + "name": "APIResponse", + "expression": "[APIResponse]" + }, + "spec": [ + { + "type": "text", + "text": "Sends HTTP(S) [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) request and returns its response.↵The method will populate request cookies from the context and update↵context cookies from the response. The method will automatically follow redirects." + } + ], + "required": true, + "comment": "Sends HTTP(S) [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) request and returns its\nresponse. The method will populate request cookies from the context and update context cookies from the response.\nThe method will automatically follow redirects.", + "async": true, + "alias": "put", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.16", + "name": "url", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Target URL." + } + ], + "required": true, + "comment": "Target URL.", + "async": false, + "alias": "url", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.18", + "name": "params", + "type": { + "name": "RequestOptions", + "expression": "[RequestOptions]" + }, + "spec": [ + { + "type": "text", + "text": "Optional request parameters." + } + ], + "required": false, + "comment": "Optional request parameters.", + "async": false, + "alias": "options", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "options", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": { + "only": [ + "js", + "python", + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.16", + "name": "data", + "type": { + "name": "", + "union": [ { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "name", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "" - } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "name", - "overloadIndex": 0, - "paramOrOption": null + "name": "string" }, { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "value", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "" - } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "value", - "overloadIndex": 0, - "paramOrOption": null + "name": "Buffer" }, { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "domain", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "" - } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "domain", - "overloadIndex": 0, - "paramOrOption": null - }, + "name": "Serializable" + } + ], + "expression": "[string]|[Buffer]|[Serializable]" + }, + "spec": [ + { + "type": "text", + "text": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string↵and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will be↵set to `application/octet-stream` if not explicitly set." + } + ], + "required": false, + "comment": "Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string\nand `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type`\nheader will be set to `application/octet-stream` if not explicitly set.", + "async": false, + "alias": "data", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "python", + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.16", + "name": "failOnStatusCode", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned↵for all status codes." + } + ], + "required": false, + "comment": "Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status\ncodes.", + "async": false, + "alias": "failOnStatusCode", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.16", + "name": "form", + "type": { + "name": "Object", + "templates": [ { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "path", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "" - } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "path", - "overloadIndex": 0, - "paramOrOption": null + "name": "string" }, { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "expires", - "type": { - "name": "float", - "expression": "[float]" - }, - "spec": [ + "name": "", + "union": [ { - "type": "text", - "text": "Unix time in seconds." - } - ], - "required": true, - "comment": "Unix time in seconds.", - "deprecated": false, - "async": false, - "alias": "expires", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "httpOnly", - "type": { - "name": "boolean", - "expression": "[boolean]" - }, - "spec": [ + "name": "string" + }, { - "type": "text", - "text": "" + "name": "float" + }, + { + "name": "boolean" } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "httpOnly", - "overloadIndex": 0, - "paramOrOption": null + ] + } + ], + "expression": "[Object]<[string], [string]|[float]|[boolean]>" + }, + "spec": [ + { + "type": "text", + "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded`↵unless explicitly provided." + } + ], + "required": false, + "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent\nas this request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.", + "async": false, + "alias": "form", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.16", + "name": "form", + "type": { + "name": "FormData", + "expression": "[FormData]" + }, + "spec": [ + { + "type": "text", + "text": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `application/x-www-form-urlencoded`↵unless explicitly provided." + }, + { + "type": "text", + "text": "An instance of `FormData` can be created via [`method: APIRequestContext.createFormData`]." + } + ], + "required": false, + "comment": "Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent\nas this request body. If this parameter is specified `content-type` header will be set to\n`application/x-www-form-urlencoded` unless explicitly provided.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", + "async": false, + "alias": "form", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "python", + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.16", + "name": "headers", + "type": { + "name": "Object", + "templates": [ + { + "name": "string" }, + { + "name": "string" + } + ], + "expression": "[Object]<[string], [string]>" + }, + "spec": [ + { + "type": "text", + "text": "Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by it." + } + ], + "required": false, + "comment": "Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by\nit.", + "async": false, + "alias": "headers", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "python", + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.16", + "name": "ignoreHTTPSErrors", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`." + } + ], + "required": false, + "comment": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.", + "async": false, + "alias": "ignoreHTTPSErrors", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "python", + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.26", + "name": "maxRedirects", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded.↵Defaults to `20`. Pass `0` to not follow redirects." + } + ], + "required": false, + "comment": "Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is\nexceeded. Defaults to `20`. Pass `0` to not follow redirects.", + "async": false, + "alias": "maxRedirects", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.16", + "name": "multipart", + "type": { + "name": "Object", + "properties": [ { "kind": "property", "langs": {}, "experimental": false, "since": "v1.0", - "name": "secure", + "name": "name", "type": { - "name": "boolean", - "expression": "[boolean]" + "name": "string", + "expression": "[string]" }, "spec": [ { "type": "text", - "text": "" + "text": "File name" } ], "required": true, - "comment": "", - "deprecated": false, + "comment": "File name", "async": false, - "alias": "secure", + "alias": "name", "overloadIndex": 0, "paramOrOption": null }, @@ -12087,791 +13205,1277 @@ "langs": {}, "experimental": false, "since": "v1.0", - "name": "sameSite", + "name": "mimeType", "type": { - "name": "SameSiteAttribute", - "union": [ - { - "name": "\"Strict\"" - }, - { - "name": "\"Lax\"" - }, - { - "name": "\"None\"" - } - ], - "expression": "[SameSiteAttribute]<\"Strict\"|\"Lax\"|\"None\">" + "name": "string", + "expression": "[string]" }, "spec": [ { "type": "text", - "text": "" + "text": "File type" } ], "required": true, - "comment": "", - "deprecated": false, + "comment": "File type", "async": false, - "alias": "sameSite", + "alias": "mimeType", "overloadIndex": 0, "paramOrOption": null - } - ] - } - ], - "expression": "[Array]<[Object]>" - }, - "spec": [ - { - "type": "text", - "text": "" - } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "cookies", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "origins", - "type": { - "name": "Array", - "templates": [ - { - "name": "Object", - "properties": [ + }, { "kind": "property", "langs": {}, "experimental": false, "since": "v1.0", - "name": "origin", + "name": "buffer", "type": { - "name": "string", - "expression": "[string]" + "name": "Buffer", + "expression": "[Buffer]" }, "spec": [ { "type": "text", - "text": "" + "text": "File content" } ], "required": true, - "comment": "", - "deprecated": false, + "comment": "File content", "async": false, - "alias": "origin", + "alias": "buffer", "overloadIndex": 0, "paramOrOption": null + } + ], + "templates": [ + { + "name": "string" }, { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "localStorage", - "type": { - "name": "Array", - "templates": [ - { - "name": "Object", - "properties": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "name", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "" - } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "name", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "value", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "" - } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "value", - "overloadIndex": 0, - "paramOrOption": null - } - ] - } - ], - "expression": "[Array]<[Object]>" - }, - "spec": [ + "name": "", + "union": [ { - "type": "text", - "text": "" + "name": "string" + }, + { + "name": "float" + }, + { + "name": "boolean" + }, + { + "name": "ReadStream" + }, + { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "name", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "File name" + } + ], + "required": true, + "comment": "File name", + "async": false, + "alias": "name", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "mimeType", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "File type" + } + ], + "required": true, + "comment": "File type", + "async": false, + "alias": "mimeType", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "buffer", + "type": { + "name": "Buffer", + "expression": "[Buffer]" + }, + "spec": [ + { + "type": "text", + "text": "File content" + } + ], + "required": true, + "comment": "File content", + "async": false, + "alias": "buffer", + "overloadIndex": 0, + "paramOrOption": null + } + ] } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "localStorage", - "overloadIndex": 0, - "paramOrOption": null + ] } - ] - } - ], - "expression": "[Array]<[Object]>" - }, - "spec": [ - { - "type": "text", - "text": "" - } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "origins", - "overloadIndex": 0, - "paramOrOption": null - } - ], - "expression": "[Object]" - }, - "spec": [ - { - "type": "text", - "text": "Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to the constructor." - } - ], - "required": true, - "comment": "Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to\nthe constructor.", - "deprecated": false, - "async": true, - "alias": "storageState", - "overloadIndex": 0, - "paramOrOption": null, - "args": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "options", - "type": { - "name": "Object", - "properties": [ + ], + "expression": "[Object]<[string], [string]|[float]|[boolean]|[ReadStream]|[Object]>" + }, + "spec": [ + { + "type": "text", + "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data`↵unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)↵or as file-like object containing file name, mime-type and its content." + } + ], + "required": false, + "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this\nrequest body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless\nexplicitly provided. File values can be passed either as\n[`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file\nname, mime-type and its content.", + "async": false, + "alias": "multipart", + "overloadIndex": 0, + "paramOrOption": null + }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, "since": "v1.16", - "name": "path", + "name": "multipart", "type": { - "name": "path", - "expression": "[path]" + "name": "FormData", + "expression": "[FormData]" }, "spec": [ { "type": "text", - "text": "The file path to save the storage state to. If `path` is a relative path, then it is resolved relative to current working directory. If no path is provided, storage state is still returned, but won't be saved to the disk." + "text": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as↵this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data`↵unless explicitly provided. File values can be passed either as [`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream)↵or as file-like object containing file name, mime-type and its content." + }, + { + "type": "text", + "text": "An instance of `FormData` can be created via [`method: APIRequestContext.createFormData`]." } ], "required": false, - "comment": "The file path to save the storage state to. If `path` is a relative path, then it is resolved relative to current\nworking directory. If no path is provided, storage state is still returned, but won't be saved to the disk.", - "deprecated": false, + "comment": "Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this\nrequest body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless\nexplicitly provided. File values can be passed either as\n[`fs.ReadStream`](https://nodejs.org/api/fs.html#fs_class_fs_readstream) or as file-like object containing file\nname, mime-type and its content.\n\nAn instance of `FormData` can be created via [`method: APIRequestContext.createFormData`].", "async": false, - "alias": "path", + "alias": "multipart", "overloadIndex": 0, "paramOrOption": null - } - ] - }, - "required": false, - "comment": "", - "deprecated": false, - "async": false, - "alias": "options", - "overloadIndex": 0, - "paramOrOption": null - } - ] - } - ] - }, - { - "name": "APIResponse", - "spec": [ - { - "type": "text", - "text": "`APIResponse` class represents responses returned by [`method: APIRequestContext.get`] and similar methods." - }, - { - "type": "code", - "lines": [ - "import asyncio", - "from playwright.async_api import async_playwright, Playwright", - "", - "async def run(playwright: Playwright):", - " context = await playwright.request.new_context()", - " response = await context.get(\"https://example.com/user/repos\")", - " assert response.ok", - " assert response.status == 200", - " assert response.headers[\"content-type\"] == \"application/json; charset=utf-8\"", - " assert response.json()[\"name\"] == \"foobar\"", - " assert await response.body() == '{\"status\": \"ok\"}'", - "", - "", - "async def main():", - " async with async_playwright() as playwright:", - " await run(playwright)", - "", - "asyncio.run(main())" - ], - "codeLang": "python async" - }, - { - "type": "code", - "lines": [ - "from playwright.sync_api import sync_playwright", - "", - "with sync_playwright() as p:", - " context = playwright.request.new_context()", - " response = context.get(\"https://example.com/user/repos\")", - " assert response.ok", - " assert response.status == 200", - " assert response.headers[\"content-type\"] == \"application/json; charset=utf-8\"", - " assert response.json()[\"name\"] == \"foobar\"", - " assert response.body() == '{\"status\": \"ok\"}'" - ], - "codeLang": "python sync" - } - ], - "langs": {}, - "comment": "`APIResponse` class represents responses returned by [`method: APIRequestContext.get`] and similar methods.\n\n```python async\nimport asyncio\nfrom playwright.async_api import async_playwright, Playwright\n\nasync def run(playwright: Playwright):\n context = await playwright.request.new_context()\n response = await context.get(\"https://example.com/user/repos\")\n assert response.ok\n assert response.status == 200\n assert response.headers[\"content-type\"] == \"application/json; charset=utf-8\"\n assert response.json()[\"name\"] == \"foobar\"\n assert await response.body() == '{\"status\": \"ok\"}'\n\n\nasync def main():\n async with async_playwright() as playwright:\n await run(playwright)\n\nasyncio.run(main())\n```\n\n```python sync\nfrom playwright.sync_api import sync_playwright\n\nwith sync_playwright() as p:\n context = playwright.request.new_context()\n response = context.get(\"https://example.com/user/repos\")\n assert response.ok\n assert response.status == 200\n assert response.headers[\"content-type\"] == \"application/json; charset=utf-8\"\n assert response.json()[\"name\"] == \"foobar\"\n assert response.body() == '{\"status\": \"ok\"}'\n```\n", - "members": [ - { - "kind": "method", - "langs": {}, - "experimental": false, - "since": "v1.16", - "name": "body", - "type": { - "name": "Buffer", - "expression": "[Buffer]" - }, - "spec": [ - { - "type": "text", - "text": "Returns the buffer with response body." - } - ], - "required": true, - "comment": "Returns the buffer with response body.", - "deprecated": false, - "async": true, - "alias": "body", - "overloadIndex": 0, - "paramOrOption": null, - "args": [] - }, - { - "kind": "method", - "langs": {}, - "experimental": false, - "since": "v1.16", - "name": "dispose", - "type": { - "name": "void" - }, - "spec": [ - { - "type": "text", - "text": "Disposes the body of this response. If not called then the body will stay in memory until the context closes." - } - ], - "required": true, - "comment": "Disposes the body of this response. If not called then the body will stay in memory until the context closes.", - "deprecated": false, - "async": true, - "alias": "dispose", - "overloadIndex": 0, - "paramOrOption": null, - "args": [] - }, - { - "kind": "method", - "langs": {}, - "experimental": false, - "since": "v1.16", - "name": "headers", - "type": { - "name": "Object", - "templates": [ - { - "name": "string" - }, - { - "name": "string" - } - ], - "expression": "[Object]<[string], [string]>" - }, - "spec": [ - { - "type": "text", - "text": "An object with all the response HTTP headers associated with this response." - } - ], - "required": true, - "comment": "An object with all the response HTTP headers associated with this response.", - "deprecated": false, - "async": false, - "alias": "headers", - "overloadIndex": 0, - "paramOrOption": null, - "args": [] - }, - { - "kind": "method", - "langs": {}, - "experimental": false, - "since": "v1.16", - "name": "headersArray", - "type": { - "name": "Array", - "templates": [ - { - "name": "Object", - "properties": [ + }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "js", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, - "since": "v1.0", - "name": "name", + "since": "v1.16", + "name": "params", "type": { - "name": "string", - "expression": "[string]" + "name": "Object", + "templates": [ + { + "name": "string" + }, + { + "name": "", + "union": [ + { + "name": "string" + }, + { + "name": "float" + }, + { + "name": "boolean" + } + ] + } + ], + "expression": "[Object]<[string], [string]|[float]|[boolean]>" }, "spec": [ { "type": "text", - "text": "Name of the header." + "text": "Query parameters to be sent with the URL." } ], - "required": true, - "comment": "Name of the header.", - "deprecated": false, + "required": false, + "comment": "Query parameters to be sent with the URL.", "async": false, - "alias": "name", + "alias": "params", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, - "since": "v1.0", - "name": "value", + "since": "v1.16", + "name": "params", "type": { - "name": "string", - "expression": "[string]" + "name": "Object", + "templates": [ + { + "name": "string" + }, + { + "name": "Serializable" + } + ], + "expression": "[Object]<[string], [Serializable]>" }, "spec": [ { "type": "text", - "text": "Value of the header." + "text": "Query parameters to be sent with the URL." } ], - "required": true, - "comment": "Value of the header.", - "deprecated": false, + "required": false, + "comment": "Query parameters to be sent with the URL.", "async": false, - "alias": "value", + "alias": "params", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "python", + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.16", + "name": "timeout", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout." + } + ], + "required": false, + "comment": "Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.", + "async": false, + "alias": "timeout", "overloadIndex": 0, "paramOrOption": null } ] - } - ], - "expression": "[Array]<[Object]>" - }, - "spec": [ - { - "type": "text", - "text": "An array with all the request HTTP headers associated with this response. Header names are not lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times." - } - ], - "required": true, - "comment": "An array with all the request HTTP headers associated with this response. Header names are not lower-cased. Headers with\nmultiple entries, such as `Set-Cookie`, appear in the array multiple times.", - "deprecated": false, - "async": false, - "alias": "headersArray", - "overloadIndex": 0, - "paramOrOption": null, - "args": [] - }, - { - "kind": "method", - "langs": { - "only": [ - "js", - "python" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.16", - "name": "json", - "type": { - "name": "Serializable", - "expression": "[Serializable]" - }, - "spec": [ - { - "type": "text", - "text": "Returns the JSON representation of response body." - }, - { - "type": "text", - "text": "This method will throw if the response body is not parsable via `JSON.parse`." + }, + "required": false, + "comment": "", + "async": false, + "alias": "options", + "overloadIndex": 0, + "paramOrOption": null } - ], - "required": true, - "comment": "Returns the JSON representation of response body.\n\nThis method will throw if the response body is not parsable via `JSON.parse`.", - "deprecated": false, - "async": true, - "alias": "json", - "overloadIndex": 0, - "paramOrOption": null, - "args": [] + ] }, { "kind": "method", "langs": { - "only": [ - "csharp" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.16", - "name": "json", - "type": { - "name": "", - "union": [ - { - "name": "null" + "types": { + "java": { + "name": "string", + "expression": "[string]" }, - { - "name": "JsonElement" + "csharp": { + "name": "string", + "expression": "[string]" } - ], - "expression": "[null]|[JsonElement]" - }, - "spec": [ - { - "type": "text", - "text": "Returns the JSON representation of response body." - }, - { - "type": "text", - "text": "This method will throw if the response body is not parsable via `JSON.parse`." - } - ], - "required": true, - "comment": "Returns the JSON representation of response body.\n\nThis method will throw if the response body is not parsable via `JSON.parse`.", - "deprecated": false, - "async": true, - "alias": "json", - "overloadIndex": 0, - "paramOrOption": null, - "args": [] - }, - { - "kind": "method", - "langs": {}, - "experimental": false, - "since": "v1.16", - "name": "ok", - "type": { - "name": "boolean", - "expression": "[boolean]" - }, - "spec": [ - { - "type": "text", - "text": "Contains a boolean stating whether the response was successful (status in the range 200-299) or not." - } - ], - "required": true, - "comment": "Contains a boolean stating whether the response was successful (status in the range 200-299) or not.", - "deprecated": false, - "async": false, - "alias": "ok", - "overloadIndex": 0, - "paramOrOption": null, - "args": [] - }, - { - "kind": "method", - "langs": {}, - "experimental": false, - "since": "v1.16", - "name": "status", - "type": { - "name": "int", - "expression": "[int]" - }, - "spec": [ - { - "type": "text", - "text": "Contains the status code of the response (e.g., 200 for a success)." - } - ], - "required": true, - "comment": "Contains the status code of the response (e.g., 200 for a success).", - "deprecated": false, - "async": false, - "alias": "status", - "overloadIndex": 0, - "paramOrOption": null, - "args": [] - }, - { - "kind": "method", - "langs": {}, - "experimental": false, - "since": "v1.16", - "name": "statusText", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "Contains the status text of the response (e.g. usually an \"OK\" for a success)." } - ], - "required": true, - "comment": "Contains the status text of the response (e.g. usually an \"OK\" for a success).", - "deprecated": false, - "async": false, - "alias": "statusText", - "overloadIndex": 0, - "paramOrOption": null, - "args": [] - }, - { - "kind": "method", - "langs": {}, - "experimental": false, - "since": "v1.16", - "name": "text", - "type": { - "name": "string", - "expression": "[string]" }, - "spec": [ - { - "type": "text", - "text": "Returns the text representation of response body." - } - ], - "required": true, - "comment": "Returns the text representation of response body.", - "deprecated": false, - "async": true, - "alias": "text", - "overloadIndex": 0, - "paramOrOption": null, - "args": [] - }, - { - "kind": "method", - "langs": {}, "experimental": false, "since": "v1.16", - "name": "url", + "name": "storageState", "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "Contains the URL of the response." - } - ], - "required": true, - "comment": "Contains the URL of the response.", - "deprecated": false, - "async": false, - "alias": "url", - "overloadIndex": 0, - "paramOrOption": null, - "args": [] - } - ] - }, - { - "name": "APIResponseAssertions", - "spec": [ - { - "type": "text", - "text": "The `APIResponseAssertions` class provides assertion methods that can be used to make assertions about the `APIResponse` in the tests. A new instance of `APIResponseAssertions` is created by calling [`method: PlaywrightAssertions.expectAPIResponse`]:" - }, - { - "type": "code", - "lines": [ - "import { test, expect } from '@playwright/test';", - "", - "test('navigates to login', async ({ page }) => {", - " // ...", - " const response = await page.request.get('https://playwright.dev');", - " await expect(response).toBeOK();", - "});" - ], - "codeLang": "js" - }, - { - "type": "code", - "lines": [ - "...", - "import static com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat;", - "", - "public class TestPage {", - " ...", - " @Test", - " void navigatesToLoginPage() {", - " ...", - " APIResponse response = page.request().get('https://playwright.dev');", - " assertThat(response).isOK();", - " }", - "}" - ], - "codeLang": "java" - }, - { - "type": "code", - "lines": [ - "from playwright.async_api import Page, expect", - "", - "async def test_navigates_to_login_page(page: Page) -> None:", - " # ..", - " response = await page.request.get('https://playwright.dev')", - " await expect(response).to_be_ok()" - ], - "codeLang": "python async" - }, - { - "type": "code", - "lines": [ - "from playwright.sync_api import Page, expect", + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "cookies", + "type": { + "name": "Array", + "templates": [ + { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "name", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "name", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "value", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "value", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "domain", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "domain", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "path", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "path", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "expires", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Unix time in seconds." + } + ], + "required": true, + "comment": "Unix time in seconds.", + "async": false, + "alias": "expires", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "httpOnly", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "httpOnly", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "secure", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "secure", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "sameSite", + "type": { + "name": "SameSiteAttribute", + "union": [ + { + "name": "\"Strict\"" + }, + { + "name": "\"Lax\"" + }, + { + "name": "\"None\"" + } + ], + "expression": "[SameSiteAttribute]<\"Strict\"|\"Lax\"|\"None\">" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "sameSite", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ], + "expression": "[Array]<[Object]>" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "cookies", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "origins", + "type": { + "name": "Array", + "templates": [ + { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "origin", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "origin", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "localStorage", + "type": { + "name": "Array", + "templates": [ + { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "name", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "name", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "value", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "value", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ], + "expression": "[Array]<[Object]>" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "localStorage", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ], + "expression": "[Array]<[Object]>" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "origins", + "overloadIndex": 0, + "paramOrOption": null + } + ], + "expression": "[Object]" + }, + "spec": [ + { + "type": "text", + "text": "Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to the constructor." + } + ], + "required": true, + "comment": "Returns storage state for this request context, contains current cookies and local storage snapshot if it was\npassed to the constructor.", + "async": true, + "alias": "storageState", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "options", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.16", + "name": "path", + "type": { + "name": "path", + "expression": "[path]" + }, + "spec": [ + { + "type": "text", + "text": "The file path to save the storage state to. If `path` is a relative path, then it is resolved relative to↵current working directory. If no path is provided, storage↵state is still returned, but won't be saved to the disk." + } + ], + "required": false, + "comment": "The file path to save the storage state to. If `path` is a relative path, then it is resolved relative to current\nworking directory. If no path is provided, storage state is still returned, but won't be saved to the disk.", + "async": false, + "alias": "path", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + "required": false, + "comment": "", + "async": false, + "alias": "options", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ] + }, + { + "name": "APIResponse", + "spec": [ + { + "type": "text", + "text": "`APIResponse` class represents responses returned by [`method: APIRequestContext.get`] and similar methods." + }, + { + "type": "code", + "lines": [ + "import asyncio", + "from playwright.async_api import async_playwright, Playwright", "", - "def test_navigates_to_login_page(page: Page) -> None:", - " # ..", - " response = page.request.get('https://playwright.dev')", - " expect(response).to_be_ok()" + "async def run(playwright: Playwright):", + " context = await playwright.request.new_context()", + " response = await context.get(\"https://example.com/user/repos\")", + " assert response.ok", + " assert response.status == 200", + " assert response.headers[\"content-type\"] == \"application/json; charset=utf-8\"", + " assert response.json()[\"name\"] == \"foobar\"", + " assert await response.body() == '{\"status\": \"ok\"}'", + "", + "", + "async def main():", + " async with async_playwright() as playwright:", + " await run(playwright)", + "", + "asyncio.run(main())" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "from playwright.sync_api import sync_playwright", + "", + "with sync_playwright() as p:", + " context = playwright.request.new_context()", + " response = context.get(\"https://example.com/user/repos\")", + " assert response.ok", + " assert response.status == 200", + " assert response.headers[\"content-type\"] == \"application/json; charset=utf-8\"", + " assert response.json()[\"name\"] == \"foobar\"", + " assert response.body() == '{\"status\": \"ok\"}'" ], "codeLang": "python sync" } ], - "langs": { - "only": [ - "js", - "java", - "python" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, - "comment": "The `APIResponseAssertions` class provides assertion methods that can be used to make assertions about the `APIResponse`\nin the tests. A new instance of `APIResponseAssertions` is created by calling\n[`method: PlaywrightAssertions.expectAPIResponse`]:\n\n```js\nimport { test, expect } from '@playwright/test';\n\ntest('navigates to login', async ({ page }) => {\n // ...\n const response = await page.request.get('https://playwright.dev');\n await expect(response).toBeOK();\n});\n```\n\n```java\n...\nimport static com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat;\n\npublic class TestPage {\n ...\n @Test\n void navigatesToLoginPage() {\n ...\n APIResponse response = page.request().get('https://playwright.dev');\n assertThat(response).isOK();\n }\n}\n```\n\n```python async\nfrom playwright.async_api import Page, expect\n\nasync def test_navigates_to_login_page(page: Page) -> None:\n # ..\n response = await page.request.get('https://playwright.dev')\n await expect(response).to_be_ok()\n```\n\n```python sync\nfrom playwright.sync_api import Page, expect\n\ndef test_navigates_to_login_page(page: Page) -> None:\n # ..\n response = page.request.get('https://playwright.dev')\n expect(response).to_be_ok()\n```\n", + "langs": {}, + "comment": "`APIResponse` class represents responses returned by [`method: APIRequestContext.get`] and similar methods.\n\n```py\nimport asyncio\nfrom playwright.async_api import async_playwright, Playwright\n\nasync def run(playwright: Playwright):\n context = await playwright.request.new_context()\n response = await context.get(\"https://example.com/user/repos\")\n assert response.ok\n assert response.status == 200\n assert response.headers[\"content-type\"] == \"application/json; charset=utf-8\"\n assert response.json()[\"name\"] == \"foobar\"\n assert await response.body() == '{\"status\": \"ok\"}'\n\n\nasync def main():\n async with async_playwright() as playwright:\n await run(playwright)\n\nasyncio.run(main())\n```\n\n```py\nfrom playwright.sync_api import sync_playwright\n\nwith sync_playwright() as p:\n context = playwright.request.new_context()\n response = context.get(\"https://example.com/user/repos\")\n assert response.ok\n assert response.status == 200\n assert response.headers[\"content-type\"] == \"application/json; charset=utf-8\"\n assert response.json()[\"name\"] == \"foobar\"\n assert response.body() == '{\"status\": \"ok\"}'\n```\n", + "since": "v1.16", "members": [ { - "kind": "property", - "langs": { - "only": [ - "java", - "js" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, + "kind": "method", + "langs": {}, "experimental": false, - "since": "v1.20", - "name": "not", + "since": "v1.16", + "name": "body", "type": { - "name": "APIResponseAssertions", - "expression": "[APIResponseAssertions]" + "name": "Buffer", + "expression": "[Buffer]" }, "spec": [ { "type": "text", - "text": "Makes the assertion check for the opposite condition. For example, this code tests that the response status is not successful:" - }, - { - "type": "code", - "lines": [ - "await expect(response).not.toBeOK();" - ], - "codeLang": "js" - }, - { - "type": "code", - "lines": [ - "assertThat(response).not().isOK();" - ], - "codeLang": "java" + "text": "Returns the buffer with response body." } ], "required": true, - "comment": "Makes the assertion check for the opposite condition. For example, this code tests that the response status is not\nsuccessful:\n\n```js\nawait expect(response).not.toBeOK();\n```\n\n```java\nassertThat(response).not().isOK();\n```\n", - "deprecated": false, - "async": false, + "comment": "Returns the buffer with response body.", + "async": true, + "alias": "body", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.16", + "name": "dispose", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "Disposes the body of this response. If not called then the body will stay in memory until the context closes." + } + ], + "required": true, + "comment": "Disposes the body of this response. If not called then the body will stay in memory until the context closes.", + "async": true, + "alias": "dispose", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.16", + "name": "headers", + "type": { + "name": "Object", + "templates": [ + { + "name": "string" + }, + { + "name": "string" + } + ], + "expression": "[Object]<[string], [string]>" + }, + "spec": [ + { + "type": "text", + "text": "An object with all the response HTTP headers associated with this response." + } + ], + "required": true, + "comment": "An object with all the response HTTP headers associated with this response.", + "async": false, + "alias": "headers", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.16", + "name": "headersArray", + "type": { + "name": "Array", + "templates": [ + { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "name", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Name of the header." + } + ], + "required": true, + "comment": "Name of the header.", + "async": false, + "alias": "name", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "value", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Value of the header." + } + ], + "required": true, + "comment": "Value of the header.", + "async": false, + "alias": "value", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ], + "expression": "[Array]<[Object]>" + }, + "spec": [ + { + "type": "text", + "text": "An array with all the request HTTP headers associated with this response. Header names are not lower-cased.↵Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times." + } + ], + "required": true, + "comment": "An array with all the request HTTP headers associated with this response. Header names are not lower-cased. Headers\nwith multiple entries, such as `Set-Cookie`, appear in the array multiple times.", + "async": false, + "alias": "headersArray", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": { + "only": [ + "js", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.16", + "name": "json", + "type": { + "name": "Serializable", + "expression": "[Serializable]" + }, + "spec": [ + { + "type": "text", + "text": "Returns the JSON representation of response body." + }, + { + "type": "text", + "text": "This method will throw if the response body is not parsable via `JSON.parse`." + } + ], + "required": true, + "comment": "Returns the JSON representation of response body.\n\nThis method will throw if the response body is not parsable via `JSON.parse`.", + "async": true, + "alias": "json", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": { + "only": [ + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.16", + "name": "json", + "type": { + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "JsonElement" + } + ], + "expression": "[null]|[JsonElement]" + }, + "spec": [ + { + "type": "text", + "text": "Returns the JSON representation of response body." + }, + { + "type": "text", + "text": "This method will throw if the response body is not parsable via `JSON.parse`." + } + ], + "required": true, + "comment": "Returns the JSON representation of response body.\n\nThis method will throw if the response body is not parsable via `JSON.parse`.", + "async": true, + "alias": "json", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.16", + "name": "ok", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Contains a boolean stating whether the response was successful (status in the range 200-299) or not." + } + ], + "required": true, + "comment": "Contains a boolean stating whether the response was successful (status in the range 200-299) or not.", + "async": false, + "alias": "ok", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.16", + "name": "status", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "Contains the status code of the response (e.g., 200 for a success)." + } + ], + "required": true, + "comment": "Contains the status code of the response (e.g., 200 for a success).", + "async": false, + "alias": "status", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.16", + "name": "statusText", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Contains the status text of the response (e.g. usually an \"OK\" for a success)." + } + ], + "required": true, + "comment": "Contains the status text of the response (e.g. usually an \"OK\" for a success).", + "async": false, + "alias": "statusText", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.16", + "name": "text", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Returns the text representation of response body." + } + ], + "required": true, + "comment": "Returns the text representation of response body.", + "async": true, + "alias": "text", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.16", + "name": "url", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Contains the URL of the response." + } + ], + "required": true, + "comment": "Contains the URL of the response.", + "async": false, + "alias": "url", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + } + ] + }, + { + "name": "APIResponseAssertions", + "spec": [ + { + "type": "text", + "text": "The `APIResponseAssertions` class provides assertion methods that can be used to make assertions about the `APIResponse` in the tests." + }, + { + "type": "code", + "lines": [ + "import { test, expect } from '@playwright/test';", + "", + "test('navigates to login', async ({ page }) => {", + " // ...", + " const response = await page.request.get('https://playwright.dev');", + " await expect(response).toBeOK();", + "});" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "...", + "import static com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat;", + "", + "public class TestPage {", + " ...", + " @Test", + " void navigatesToLoginPage() {", + " ...", + " APIResponse response = page.request().get('https://playwright.dev');", + " assertThat(response).isOK();", + " }", + "}" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "from playwright.async_api import Page, expect", + "", + "async def test_navigates_to_login_page(page: Page) -> None:", + " # ..", + " response = await page.request.get('https://playwright.dev')", + " await expect(response).to_be_ok()" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "from playwright.sync_api import Page, expect", + "", + "def test_navigates_to_login_page(page: Page) -> None:", + " # ..", + " response = page.request.get('https://playwright.dev')", + " expect(response).to_be_ok()" + ], + "codeLang": "python sync" + } + ], + "langs": {}, + "comment": "The `APIResponseAssertions` class provides assertion methods that can be used to make assertions about the\n`APIResponse` in the tests.\n\n```js\nimport { test, expect } from '@playwright/test';\n\ntest('navigates to login', async ({ page }) => {\n // ...\n const response = await page.request.get('https://playwright.dev');\n await expect(response).toBeOK();\n});\n```\n\n```java\n...\nimport static com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat;\n\npublic class TestPage {\n ...\n @Test\n void navigatesToLoginPage() {\n ...\n APIResponse response = page.request().get('https://playwright.dev');\n assertThat(response).isOK();\n }\n}\n```\n\n```py\nfrom playwright.async_api import Page, expect\n\nasync def test_navigates_to_login_page(page: Page) -> None:\n # ..\n response = await page.request.get('https://playwright.dev')\n await expect(response).to_be_ok()\n```\n\n```py\nfrom playwright.sync_api import Page, expect\n\ndef test_navigates_to_login_page(page: Page) -> None:\n # ..\n response = page.request.get('https://playwright.dev')\n expect(response).to_be_ok()\n```\n", + "since": "v1.18", + "members": [ + { + "kind": "property", + "langs": { + "only": [ + "java", + "js", + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.20", + "name": "not", + "type": { + "name": "APIResponseAssertions", + "expression": "[APIResponseAssertions]" + }, + "spec": [ + { + "type": "text", + "text": "Makes the assertion check for the opposite condition. For example, this code tests that the response status is not successful:" + }, + { + "type": "code", + "lines": [ + "await expect(response).not.toBeOK();" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "assertThat(response).not().isOK();" + ], + "codeLang": "java" + } + ], + "required": true, + "comment": "Makes the assertion check for the opposite condition. For example, this code tests that the response status is not\nsuccessful:\n\n```js\nawait expect(response).not.toBeOK();\n```\n\n```java\nassertThat(response).not().isOK();\n```\n", + "async": false, "alias": "not", "overloadIndex": 0, "paramOrOption": null, @@ -12901,7 +14505,6 @@ ], "required": true, "comment": "The opposite of [`method: APIResponseAssertions.toBeOK`].", - "deprecated": false, "async": true, "alias": "NotToBeOK", "overloadIndex": 0, @@ -12926,7 +14529,11 @@ "spec": [ { "type": "text", - "text": "Ensures the response status code is within [200..299] range." + "text": "Ensures the response status code is within `200..299` range." + }, + { + "type": "text", + "text": "**Usage**" }, { "type": "code", @@ -12965,8 +14572,7 @@ } ], "required": true, - "comment": "Ensures the response status code is within [200..299] range.\n\n```js\nawait expect(response).toBeOK();\n```\n\n```java\nassertThat(response).isOK();\n```\n\n```python async\nfrom playwright.async_api import expect\n\n# ...\nawait expect(response).to_be_ok()\n```\n\n```python sync\nimport re\nfrom playwright.sync_api import expect\n\n# ...\nexpect(response).to_be_ok()\n```\n", - "deprecated": false, + "comment": "Ensures the response status code is within `200..299` range.\n\n**Usage**\n\n```js\nawait expect(response).toBeOK();\n```\n\n```java\nassertThat(response).isOK();\n```\n\n```py\nfrom playwright.async_api import expect\n\n# ...\nawait expect(response).to_be_ok()\n```\n\n```py\nimport re\nfrom playwright.sync_api import expect\n\n# ...\nexpect(response).to_be_ok()\n```\n", "async": true, "alias": "toBeOK", "overloadIndex": 0, @@ -13064,7 +14670,7 @@ "", "using var playwright = await Playwright.CreateAsync();", "var firefox = playwright.Firefox;", - "var browser = await firefox.LaunchAsync(new BrowserTypeLaunchOptions { Headless = false });", + "var browser = await firefox.LaunchAsync(new() { Headless = false });", "var page = await browser.NewPageAsync();", "await page.GotoAsync(\"https://www.bing.com\");", "await browser.CloseAsync();" @@ -13074,7 +14680,8 @@ ], "extends": "EventEmitter", "langs": {}, - "comment": "- extends: [EventEmitter]\n\nA Browser is created via [`method: BrowserType.launch`]. An example of using a `Browser` to create a `Page`:\n\n```js\nconst { firefox } = require('playwright'); // Or 'chromium' or 'webkit'.\n\n(async () => {\n const browser = await firefox.launch();\n const page = await browser.newPage();\n await page.goto('https://example.com');\n await browser.close();\n})();\n```\n\n```java\nimport com.microsoft.playwright.*;\n\npublic class Example {\n public static void main(String[] args) {\n try (Playwright playwright = Playwright.create()) {\n BrowserType firefox = playwright.firefox()\n Browser browser = firefox.launch();\n Page page = browser.newPage();\n page.navigate('https://example.com');\n browser.close();\n }\n }\n}\n```\n\n```python async\nimport asyncio\nfrom playwright.async_api import async_playwright\n\nasync def run(playwright):\n firefox = playwright.firefox\n browser = await firefox.launch()\n page = await browser.new_page()\n await page.goto(\"https://example.com\")\n await browser.close()\n\nasync def main():\n async with async_playwright() as playwright:\n await run(playwright)\nasyncio.run(main())\n```\n\n```python sync\nfrom playwright.sync_api import sync_playwright\n\ndef run(playwright):\n firefox = playwright.firefox\n browser = firefox.launch()\n page = browser.new_page()\n page.goto(\"https://example.com\")\n browser.close()\n\nwith sync_playwright() as playwright:\n run(playwright)\n```\n\n```csharp\nusing Microsoft.Playwright;\n\nusing var playwright = await Playwright.CreateAsync();\nvar firefox = playwright.Firefox;\nvar browser = await firefox.LaunchAsync(new BrowserTypeLaunchOptions { Headless = false });\nvar page = await browser.NewPageAsync();\nawait page.GotoAsync(\"https://www.bing.com\");\nawait browser.CloseAsync();\n```\n", + "comment": "- extends: [EventEmitter]\n\nA Browser is created via [`method: BrowserType.launch`]. An example of using a `Browser` to create a `Page`:\n\n```js\nconst { firefox } = require('playwright'); // Or 'chromium' or 'webkit'.\n\n(async () => {\n const browser = await firefox.launch();\n const page = await browser.newPage();\n await page.goto('https://example.com');\n await browser.close();\n})();\n```\n\n```java\nimport com.microsoft.playwright.*;\n\npublic class Example {\n public static void main(String[] args) {\n try (Playwright playwright = Playwright.create()) {\n BrowserType firefox = playwright.firefox()\n Browser browser = firefox.launch();\n Page page = browser.newPage();\n page.navigate('https://example.com');\n browser.close();\n }\n }\n}\n```\n\n```py\nimport asyncio\nfrom playwright.async_api import async_playwright\n\nasync def run(playwright):\n firefox = playwright.firefox\n browser = await firefox.launch()\n page = await browser.new_page()\n await page.goto(\"https://example.com\")\n await browser.close()\n\nasync def main():\n async with async_playwright() as playwright:\n await run(playwright)\nasyncio.run(main())\n```\n\n```py\nfrom playwright.sync_api import sync_playwright\n\ndef run(playwright):\n firefox = playwright.firefox\n browser = firefox.launch()\n page = browser.new_page()\n page.goto(\"https://example.com\")\n browser.close()\n\nwith sync_playwright() as playwright:\n run(playwright)\n```\n\n```csharp\nusing Microsoft.Playwright;\n\nusing var playwright = await Playwright.CreateAsync();\nvar firefox = playwright.Firefox;\nvar browser = await firefox.LaunchAsync(new() { Headless = false });\nvar page = await browser.NewPageAsync();\nawait page.GotoAsync(\"https://www.bing.com\");\nawait browser.CloseAsync();\n```\n", + "since": "v1.8", "members": [ { "kind": "event", @@ -13103,8 +14710,7 @@ } ], "required": true, - "comment": "Emitted when Browser gets disconnected from the browser application. This might happen because of one of the following:\n- Browser application is closed or crashed.\n- The [`method: Browser.close`] method was called.", - "deprecated": false, + "comment": "Emitted when Browser gets disconnected from the browser application. This might happen because of one of the\nfollowing:\n- Browser application is closed or crashed.\n- The [`method: Browser.close`] method was called.", "async": false, "alias": "disconnected", "overloadIndex": 0, @@ -13129,7 +14735,6 @@ ], "required": true, "comment": "Get the browser type (chromium, firefox or webkit) that the browser belongs to.", - "deprecated": false, "async": false, "alias": "browserType", "overloadIndex": 0, @@ -13148,11 +14753,11 @@ "spec": [ { "type": "text", - "text": "In case this browser is obtained using [`method: BrowserType.launch`], closes the browser and all of its pages (if any were opened)." + "text": "In case this browser is obtained using [`method: BrowserType.launch`], closes the browser and all of its pages (if any↵were opened)." }, { "type": "text", - "text": "In case this browser is connected to, clears all created contexts belonging to this browser and disconnects from the browser server." + "text": "In case this browser is connected to, clears all created contexts belonging to this browser and disconnects from the↵browser server." }, { "type": "note", @@ -13165,8 +14770,7 @@ } ], "required": true, - "comment": "In case this browser is obtained using [`method: BrowserType.launch`], closes the browser and all of its pages (if any\nwere opened).\n\nIn case this browser is connected to, clears all created contexts belonging to this browser and disconnects from the\nbrowser server.\n\n> NOTE: This is similar to force quitting the browser. Therefore, you should call [`method: BrowserContext.close`] on\nany `BrowserContext`'s you explicitly created earlier with [`method: Browser.newContext`] **before** calling\n[`method: Browser.close`].\n\nThe `Browser` object itself is considered to be disposed and cannot be used anymore.", - "deprecated": false, + "comment": "In case this browser is obtained using [`method: BrowserType.launch`], closes the browser and all of its pages (if\nany were opened).\n\nIn case this browser is connected to, clears all created contexts belonging to this browser and disconnects from\nthe browser server.\n\n**NOTE** This is similar to force quitting the browser. Therefore, you should call [`method: BrowserContext.close`]\non any `BrowserContext`'s you explicitly created earlier with [`method: Browser.newContext`] **before** calling\n[`method: Browser.close`].\n\nThe `Browser` object itself is considered to be disposed and cannot be used anymore.", "async": true, "alias": "close", "overloadIndex": 0, @@ -13193,6 +14797,10 @@ "type": "text", "text": "Returns an array of all open browser contexts. In a newly created browser, this will return zero browser contexts." }, + { + "type": "text", + "text": "**Usage**" + }, { "type": "code", "lines": [ @@ -13247,8 +14855,7 @@ } ], "required": true, - "comment": "Returns an array of all open browser contexts. In a newly created browser, this will return zero browser contexts.\n\n```js\nconst browser = await pw.webkit.launch();\nconsole.log(browser.contexts().length); // prints `0`\n\nconst context = await browser.newContext();\nconsole.log(browser.contexts().length); // prints `1`\n```\n\n```java\nBrowser browser = pw.webkit().launch();\nSystem.out.println(browser.contexts().size()); // prints \"0\"\nBrowserContext context = browser.newContext();\nSystem.out.println(browser.contexts().size()); // prints \"1\"\n```\n\n```python async\nbrowser = await pw.webkit.launch()\nprint(len(browser.contexts())) # prints `0`\ncontext = await browser.new_context()\nprint(len(browser.contexts())) # prints `1`\n```\n\n```python sync\nbrowser = pw.webkit.launch()\nprint(len(browser.contexts())) # prints `0`\ncontext = browser.new_context()\nprint(len(browser.contexts())) # prints `1`\n```\n\n```csharp\nusing var playwright = await Playwright.CreateAsync();\nvar browser = await playwright.Webkit.LaunchAsync();\nSystem.Console.WriteLine(browser.Contexts.Count); // prints \"0\"\nvar context = await browser.NewContextAsync();\nSystem.Console.WriteLine(browser.Contexts.Count); // prints \"1\"\n```\n", - "deprecated": false, + "comment": "Returns an array of all open browser contexts. In a newly created browser, this will return zero browser contexts.\n\n**Usage**\n\n```js\nconst browser = await pw.webkit.launch();\nconsole.log(browser.contexts().length); // prints `0`\n\nconst context = await browser.newContext();\nconsole.log(browser.contexts().length); // prints `1`\n```\n\n```java\nBrowser browser = pw.webkit().launch();\nSystem.out.println(browser.contexts().size()); // prints \"0\"\nBrowserContext context = browser.newContext();\nSystem.out.println(browser.contexts().size()); // prints \"1\"\n```\n\n```py\nbrowser = await pw.webkit.launch()\nprint(len(browser.contexts())) # prints `0`\ncontext = await browser.new_context()\nprint(len(browser.contexts())) # prints `1`\n```\n\n```py\nbrowser = pw.webkit.launch()\nprint(len(browser.contexts())) # prints `0`\ncontext = browser.new_context()\nprint(len(browser.contexts())) # prints `1`\n```\n\n```csharp\nusing var playwright = await Playwright.CreateAsync();\nvar browser = await playwright.Webkit.LaunchAsync();\nSystem.Console.WriteLine(browser.Contexts.Count); // prints \"0\"\nvar context = await browser.NewContextAsync();\nSystem.Console.WriteLine(browser.Contexts.Count); // prints \"1\"\n```\n", "async": false, "alias": "contexts", "overloadIndex": 0, @@ -13273,7 +14880,6 @@ ], "required": true, "comment": "Indicates that the browser is connected.", - "deprecated": false, "async": false, "alias": "isConnected", "overloadIndex": 0, @@ -13285,7 +14891,8 @@ "langs": { "only": [ "js", - "python" + "python", + "csharp" ], "aliases": {}, "types": {}, @@ -13310,8 +14917,7 @@ } ], "required": true, - "comment": "> NOTE: CDP Sessions are only supported on Chromium-based browsers.\n\nReturns the newly created browser session.", - "deprecated": false, + "comment": "**NOTE** CDP Sessions are only supported on Chromium-based browsers.\n\nReturns the newly created browser session.", "async": true, "alias": "newBrowserCDPSession", "overloadIndex": 0, @@ -13336,7 +14942,11 @@ { "type": "note", "noteType": "note", - "text": "If directly using this method to create `BrowserContext`s, it is best practice to explicilty close the returned context via [`method: BrowserContext.close`] when your code is done with the `BrowserContext`, and before calling [`method: Browser.close`]. This will ensure the `context` is closed gracefully and any artifacts—like HARs and videos—are fully flushed and saved." + "text": "If directly using this method to create `BrowserContext`s, it is best practice to explicitly close the returned context via [`method: BrowserContext.close`] when your code is done with the `BrowserContext`,↵and before calling [`method: Browser.close`]. This will ensure the `context` is closed gracefully and any artifacts—like HARs and videos—are fully flushed and saved." + }, + { + "type": "text", + "text": "**Usage**" }, { "type": "code", @@ -13366,7 +14976,7 @@ "Page page = context.newPage();", "page.navigate('https://example.com');", "", - "// Gracefull close up everything", + "// Graceful close up everything", "context.close();", "browser.close();" ], @@ -13423,8 +15033,7 @@ } ], "required": true, - "comment": "Creates a new browser context. It won't share cookies/cache with other browser contexts.\n\n> NOTE: If directly using this method to create `BrowserContext`s, it is best practice to explicilty close the returned\ncontext via [`method: BrowserContext.close`] when your code is done with the `BrowserContext`, and before calling\n[`method: Browser.close`]. This will ensure the `context` is closed gracefully and any artifacts—like HARs and\nvideos—are fully flushed and saved.\n\n```js\n(async () => {\n const browser = await playwright.firefox.launch(); // Or 'chromium' or 'webkit'.\n // Create a new incognito browser context.\n const context = await browser.newContext();\n // Create a new page in a pristine context.\n const page = await context.newPage();\n await page.goto('https://example.com');\n\n // Gracefully close up everything\n await context.close();\n await browser.close();\n})();\n```\n\n```java\nBrowser browser = playwright.firefox().launch(); // Or 'chromium' or 'webkit'.\n// Create a new incognito browser context.\nBrowserContext context = browser.newContext();\n// Create a new page in a pristine context.\nPage page = context.newPage();\npage.navigate('https://example.com');\n\n// Gracefull close up everything\ncontext.close();\nbrowser.close();\n```\n\n```python async\nbrowser = await playwright.firefox.launch() # or \"chromium\" or \"webkit\".\n# create a new incognito browser context.\ncontext = await browser.new_context()\n# create a new page in a pristine context.\npage = await context.new_page()\nawait page.goto(\"https://example.com\")\n\n# gracefully close up everything\nawait context.close()\nawait browser.close()\n```\n\n```python sync\nbrowser = playwright.firefox.launch() # or \"chromium\" or \"webkit\".\n# create a new incognito browser context.\ncontext = browser.new_context()\n# create a new page in a pristine context.\npage = context.new_page()\npage.goto(\"https://example.com\")\n\n# gracefully close up everything\ncontext.close()\nbrowser.close()\n```\n\n```csharp\nusing var playwright = await Playwright.CreateAsync();\nvar browser = await playwright.Firefox.LaunchAsync();\n// Create a new incognito browser context.\nvar context = await browser.NewContextAsync();\n// Create a new page in a pristine context.\nvar page = await context.NewPageAsync(); ;\nawait page.GotoAsync(\"https://www.bing.com\");\n\n// Gracefully close up everything\nawait context.CloseAsync();\nawait browser.CloseAsync();\n```\n", - "deprecated": false, + "comment": "Creates a new browser context. It won't share cookies/cache with other browser contexts.\n\n**NOTE** If directly using this method to create `BrowserContext`s, it is best practice to explicitly close the\nreturned context via [`method: BrowserContext.close`] when your code is done with the `BrowserContext`, and before\ncalling [`method: Browser.close`]. This will ensure the `context` is closed gracefully and any artifacts—like HARs\nand videos—are fully flushed and saved.\n\n**Usage**\n\n```js\n(async () => {\n const browser = await playwright.firefox.launch(); // Or 'chromium' or 'webkit'.\n // Create a new incognito browser context.\n const context = await browser.newContext();\n // Create a new page in a pristine context.\n const page = await context.newPage();\n await page.goto('https://example.com');\n\n // Gracefully close up everything\n await context.close();\n await browser.close();\n})();\n```\n\n```java\nBrowser browser = playwright.firefox().launch(); // Or 'chromium' or 'webkit'.\n// Create a new incognito browser context.\nBrowserContext context = browser.newContext();\n// Create a new page in a pristine context.\nPage page = context.newPage();\npage.navigate('https://example.com');\n\n// Graceful close up everything\ncontext.close();\nbrowser.close();\n```\n\n```py\nbrowser = await playwright.firefox.launch() # or \"chromium\" or \"webkit\".\n# create a new incognito browser context.\ncontext = await browser.new_context()\n# create a new page in a pristine context.\npage = await context.new_page()\nawait page.goto(\"https://example.com\")\n\n# gracefully close up everything\nawait context.close()\nawait browser.close()\n```\n\n```py\nbrowser = playwright.firefox.launch() # or \"chromium\" or \"webkit\".\n# create a new incognito browser context.\ncontext = browser.new_context()\n# create a new page in a pristine context.\npage = context.new_page()\npage.goto(\"https://example.com\")\n\n# gracefully close up everything\ncontext.close()\nbrowser.close()\n```\n\n```csharp\nusing var playwright = await Playwright.CreateAsync();\nvar browser = await playwright.Firefox.LaunchAsync();\n// Create a new incognito browser context.\nvar context = await browser.NewContextAsync();\n// Create a new page in a pristine context.\nvar page = await context.NewPageAsync(); ;\nawait page.GotoAsync(\"https://www.bing.com\");\n\n// Gracefully close up everything\nawait context.CloseAsync();\nawait browser.CloseAsync();\n```\n", "async": true, "alias": "newContext", "overloadIndex": 0, @@ -13457,7 +15066,6 @@ ], "required": false, "comment": "Whether to automatically download all the attachments. Defaults to `true` where all the downloads are accepted.", - "deprecated": false, "async": false, "alias": "acceptDownloads", "overloadIndex": 0, @@ -13495,8 +15103,7 @@ } ], "required": false, - "comment": "When using [`method: Page.goto`], [`method: Page.route`], [`method: Page.waitForURL`], [`method: Page.waitForRequest`],\nor [`method: Page.waitForResponse`] it takes the base URL in consideration by using the\n[`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the corresponding URL.\nExamples:\n- baseURL: `http://localhost:3000` and navigating to `/bar.html` results in `http://localhost:3000/bar.html`\n- baseURL: `http://localhost:3000/foo/` and navigating to `./bar.html` results in `http://localhost:3000/foo/bar.html`\n- baseURL: `http://localhost:3000/foo` (without trailing slash) and navigating to `./bar.html` results in\n `http://localhost:3000/bar.html`", - "deprecated": false, + "comment": "When using [`method: Page.goto`], [`method: Page.route`], [`method: Page.waitForURL`],\n[`method: Page.waitForRequest`], or [`method: Page.waitForResponse`] it takes the base URL in consideration by\nusing the [`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the\ncorresponding URL. Examples:\n- baseURL: `http://localhost:3000` and navigating to `/bar.html` results in `http://localhost:3000/bar.html`\n- baseURL: `http://localhost:3000/foo/` and navigating to `./bar.html` results in\n `http://localhost:3000/foo/bar.html`\n- baseURL: `http://localhost:3000/foo` (without trailing slash) and navigating to `./bar.html` results in\n `http://localhost:3000/bar.html`", "async": false, "alias": "baseURL", "overloadIndex": 0, @@ -13520,7 +15127,6 @@ ], "required": false, "comment": "Toggles bypassing page's Content-Security-Policy.", - "deprecated": false, "async": false, "alias": "bypassCSP", "overloadIndex": 0, @@ -13528,34 +15134,49 @@ }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "js", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, "since": "v1.8", "name": "colorScheme", "type": { - "name": "ColorScheme", + "name": "", "union": [ { - "name": "\"light\"" - }, - { - "name": "\"dark\"" + "name": "null" }, { - "name": "\"no-preference\"" + "name": "ColorScheme", + "union": [ + { + "name": "\"light\"" + }, + { + "name": "\"dark\"" + }, + { + "name": "\"no-preference\"" + } + ] } ], - "expression": "[ColorScheme]<\"light\"|\"dark\"|\"no-preference\">" + "expression": "null|[ColorScheme]<\"light\"|\"dark\"|\"no-preference\">" }, "spec": [ { "type": "text", - "text": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See [`method: Page.emulateMedia`] for more details. Defaults to `'light'`." + "text": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See↵[`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to `'light'`." } ], "required": false, - "comment": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Defaults to `'light'`.", - "deprecated": false, + "comment": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to\n`'light'`.", "async": false, "alias": "colorScheme", "overloadIndex": 0, @@ -13563,25 +15184,69 @@ }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "csharp", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, "since": "v1.8", - "name": "deviceScaleFactor", + "name": "colorScheme", "type": { - "name": "float", - "expression": "[float]" - }, - "spec": [ - { - "type": "text", - "text": "Specify device scale factor (can be thought of as dpr). Defaults to `1`." - } - ], - "required": false, - "comment": "Specify device scale factor (can be thought of as dpr). Defaults to `1`.", - "deprecated": false, - "async": false, - "alias": "deviceScaleFactor", + "name": "ColorScheme", + "union": [ + { + "name": "\"light\"" + }, + { + "name": "\"dark\"" + }, + { + "name": "\"no-preference\"" + }, + { + "name": "\"null\"" + } + ], + "expression": "[ColorScheme]<\"light\"|\"dark\"|\"no-preference\"|\"null\">" + }, + "spec": [ + { + "type": "text", + "text": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See↵[`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to `'light'`." + } + ], + "required": false, + "comment": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to\n`'light'`.", + "async": false, + "alias": "colorScheme", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "deviceScaleFactor", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Specify device scale factor (can be thought of as dpr). Defaults to `1`." + } + ], + "required": false, + "comment": "Specify device scale factor (can be thought of as dpr). Defaults to `1`.", + "async": false, + "alias": "deviceScaleFactor", "overloadIndex": 0, "paramOrOption": null }, @@ -13611,7 +15276,6 @@ ], "required": false, "comment": "An object containing additional HTTP headers to be sent with every request.", - "deprecated": false, "async": false, "alias": "extraHTTPHeaders", "overloadIndex": 0, @@ -13619,7 +15283,62 @@ }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "js", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "forcedColors", + "type": { + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "ForcedColors", + "union": [ + { + "name": "\"active\"" + }, + { + "name": "\"none\"" + } + ] + } + ], + "expression": "null|[ForcedColors]<\"active\"|\"none\">" + }, + "spec": [ + { + "type": "text", + "text": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See [`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to `'none'`." + } + ], + "required": false, + "comment": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See\n[`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to\n`'none'`.", + "async": false, + "alias": "forcedColors", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, "since": "v1.8", "name": "forcedColors", @@ -13631,24 +15350,21 @@ }, { "name": "\"none\"" + }, + { + "name": "\"null\"" } ], - "expression": "[ForcedColors]<\"active\"|\"none\">" + "expression": "[ForcedColors]<\"active\"|\"none\"|\"null\">" }, "spec": [ { "type": "text", - "text": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See [`method: Page.emulateMedia`] for more details. Defaults to `'none'`." - }, - { - "type": "note", - "noteType": "note", - "text": "It's not supported in WebKit, see [here](https://bugs.webkit.org/show_bug.cgi?id=225281) in their issue tracker." + "text": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See [`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to `'none'`." } ], "required": false, - "comment": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See [`method: Page.emulateMedia`]\nfor more details. Defaults to `'none'`.\n\n> NOTE: It's not supported in WebKit, see [here](https://bugs.webkit.org/show_bug.cgi?id=225281) in their issue tracker.", - "deprecated": false, + "comment": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See\n[`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to\n`'none'`.", "async": false, "alias": "forcedColors", "overloadIndex": 0, @@ -13681,7 +15397,6 @@ ], "required": true, "comment": "Latitude between -90 and 90.", - "deprecated": false, "async": false, "alias": "latitude", "overloadIndex": 0, @@ -13705,7 +15420,6 @@ ], "required": true, "comment": "Longitude between -180 and 180.", - "deprecated": false, "async": false, "alias": "longitude", "overloadIndex": 0, @@ -13729,7 +15443,6 @@ ], "required": false, "comment": "Non-negative accuracy value. Defaults to `0`.", - "deprecated": false, "async": false, "alias": "accuracy", "overloadIndex": 0, @@ -13741,7 +15454,6 @@ "spec": [], "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "geolocation", "overloadIndex": 0, @@ -13765,7 +15477,6 @@ ], "required": false, "comment": "Specifies if viewport supports touch events. Defaults to false.", - "deprecated": false, "async": false, "alias": "hasTouch", "overloadIndex": 0, @@ -13798,7 +15509,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "username", "overloadIndex": 0, @@ -13822,7 +15532,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "password", "overloadIndex": 0, @@ -13839,7 +15548,6 @@ ], "required": false, "comment": "Credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication).", - "deprecated": false, "async": false, "alias": "httpCredentials", "overloadIndex": 0, @@ -13863,7 +15571,6 @@ ], "required": false, "comment": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.", - "deprecated": false, "async": false, "alias": "ignoreHTTPSErrors", "overloadIndex": 0, @@ -13882,12 +15589,11 @@ "spec": [ { "type": "text", - "text": "Whether the `meta viewport` tag is taken into account and touch events are enabled. Defaults to `false`. Not supported in Firefox." + "text": "Whether the `meta viewport` tag is taken into account and touch events are enabled. Defaults to `false`. Not supported↵in Firefox." } ], "required": false, - "comment": "Whether the `meta viewport` tag is taken into account and touch events are enabled. Defaults to `false`. Not supported\nin Firefox.", - "deprecated": false, + "comment": "Whether the `meta viewport` tag is taken into account and touch events are enabled. Defaults to `false`. Not\nsupported in Firefox.", "async": false, "alias": "isMobile", "overloadIndex": 0, @@ -13911,7 +15617,6 @@ ], "required": false, "comment": "Whether or not to enable JavaScript in the context. Defaults to `true`.", - "deprecated": false, "async": false, "alias": "javaScriptEnabled", "overloadIndex": 0, @@ -13930,12 +15635,11 @@ "spec": [ { "type": "text", - "text": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value, `Accept-Language` request header value as well as number and date formatting rules." + "text": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value, `Accept-Language`↵request header value as well as number and date formatting rules." } ], "required": false, - "comment": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value, `Accept-Language`\nrequest header value as well as number and date formatting rules.", - "deprecated": false, + "comment": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value,\n`Accept-Language` request header value as well as number and date formatting rules.", "async": false, "alias": "locale", "overloadIndex": 0, @@ -13966,7 +15670,6 @@ ], "required": false, "comment": "Logger sink for Playwright logging.", - "deprecated": false, "async": false, "alias": "logger", "overloadIndex": 0, @@ -13997,7 +15700,6 @@ ], "required": false, "comment": "Does not enforce fixed viewport, allows resizing window in the headed mode.", - "deprecated": false, "async": false, "alias": "noViewport", "overloadIndex": 0, @@ -14021,7 +15723,6 @@ ], "required": false, "comment": "Whether to emulate network being offline. Defaults to `false`.", - "deprecated": false, "async": false, "alias": "offline", "overloadIndex": 0, @@ -14045,12 +15746,11 @@ "spec": [ { "type": "text", - "text": "A list of permissions to grant to all pages in this context. See [`method: BrowserContext.grantPermissions`] for more details." + "text": "A list of permissions to grant to all pages in this context. See↵[`method: BrowserContext.grantPermissions`] for more details." } ], "required": false, - "comment": "A list of permissions to grant to all pages in this context. See [`method: BrowserContext.grantPermissions`] for more\ndetails.", - "deprecated": false, + "comment": "A list of permissions to grant to all pages in this context. See [`method: BrowserContext.grantPermissions`] for\nmore details.", "async": false, "alias": "permissions", "overloadIndex": 0, @@ -14078,12 +15778,11 @@ "spec": [ { "type": "text", - "text": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example `http://myproxy.com:3128` or `socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP proxy." + "text": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example↵`http://myproxy.com:3128` or `socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP proxy." } ], "required": true, "comment": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example `http://myproxy.com:3128` or\n`socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP proxy.", - "deprecated": false, "async": false, "alias": "server", "overloadIndex": 0, @@ -14107,7 +15806,6 @@ ], "required": false, "comment": "Optional comma-separated domains to bypass proxy, for example `\".com, chromium.org, .domain.com\"`.", - "deprecated": false, "async": false, "alias": "bypass", "overloadIndex": 0, @@ -14131,7 +15829,6 @@ ], "required": false, "comment": "Optional username to use if HTTP proxy requires authentication.", - "deprecated": false, "async": false, "alias": "username", "overloadIndex": 0, @@ -14155,7 +15852,6 @@ ], "required": false, "comment": "Optional password to use if HTTP proxy requires authentication.", - "deprecated": false, "async": false, "alias": "password", "overloadIndex": 0, @@ -14172,12 +15868,11 @@ { "type": "note", "noteType": "note", - "text": "For Chromium on Windows the browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example `launch({ proxy: { server: 'http://per-context' } })`." + "text": "For Chromium on Windows the browser needs to be launched with the global proxy for this option to work. If all↵contexts override the proxy, global proxy will be never used and can be any string, for example↵`launch({ proxy: { server: 'http://per-context' } })`." } ], "required": false, - "comment": "Network proxy settings to use with this context.\n\n> NOTE: For Chromium on Windows the browser needs to be launched with the global proxy for this option to work. If all\ncontexts override the proxy, global proxy will be never used and can be any string, for example `launch({ proxy: {\nserver: 'http://per-context' } })`.", - "deprecated": false, + "comment": "Network proxy settings to use with this context.\n\n**NOTE** For Chromium on Windows the browser needs to be launched with the global proxy for this option to work. If\nall contexts override the proxy, global proxy will be never used and can be any string, for example `launch({\nproxy: { server: 'http://per-context' } })`.", "async": false, "alias": "proxy", "overloadIndex": 0, @@ -14212,12 +15907,11 @@ "spec": [ { "type": "text", - "text": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`. Deprecated, use `content` policy instead." + "text": "Optional setting to control whether to omit request content from the HAR. Defaults to↵`false`. Deprecated, use `content` policy instead." } ], "required": false, - "comment": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`. Deprecated, use `content`\npolicy instead.", - "deprecated": false, + "comment": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`. Deprecated, use\n`content` policy instead.", "async": false, "alias": "omitContent", "overloadIndex": 0, @@ -14247,12 +15941,11 @@ "spec": [ { "type": "text", - "text": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach` is specified, resources are persistet as separate files or entries in the ZIP archive. If `embed` is specified, content is stored inline the HAR file as per HAR specification. Defaults to `attach` for `.zip` output files and to `embed` for all other file extensions." + "text": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach` is specified, resources are persisted as separate files or entries in the ZIP archive. If `embed` is specified, content is stored inline the HAR file as per HAR specification. Defaults to `attach` for `.zip` output files and to `embed` for all other file extensions." } ], "required": false, - "comment": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach`\nis specified, resources are persistet as separate files or entries in the ZIP archive. If `embed` is specified, content\nis stored inline the HAR file as per HAR specification. Defaults to `attach` for `.zip` output files and to `embed` for\nall other file extensions.", - "deprecated": false, + "comment": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If\n`attach` is specified, resources are persisted as separate files or entries in the ZIP archive. If `embed` is\nspecified, content is stored inline the HAR file as per HAR specification. Defaults to `attach` for `.zip` output\nfiles and to `embed` for all other file extensions.", "async": false, "alias": "content", "overloadIndex": 0, @@ -14276,7 +15969,6 @@ ], "required": true, "comment": "Path on the filesystem to write the HAR file to. If the file name ends with `.zip`, `content: 'attach'` is used by\ndefault.", - "deprecated": false, "async": false, "alias": "path", "overloadIndex": 0, @@ -14307,8 +15999,7 @@ } ], "required": false, - "comment": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies,\nsecurity and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.", - "deprecated": false, + "comment": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page,\ncookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.", "async": false, "alias": "mode", "overloadIndex": 0, @@ -14340,7 +16031,6 @@ ], "required": false, "comment": "A glob or regex pattern to filter requests that are stored in the HAR. When a `baseURL` via the context options was\nprovided and the passed URL is a path, it gets merged via the\n[`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor.", - "deprecated": false, "async": false, "alias": "urlFilter", "overloadIndex": 0, @@ -14352,12 +16042,11 @@ "spec": [ { "type": "text", - "text": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into `recordHar.path` file. If not specified, the HAR is not recorded. Make sure to await [`method: BrowserContext.close`] for the HAR to be saved." + "text": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into `recordHar.path` file. If not↵specified, the HAR is not recorded. Make sure to await [`method: BrowserContext.close`] for the HAR to be↵saved." } ], "required": false, - "comment": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into `recordHar.path` file. If not\nspecified, the HAR is not recorded. Make sure to await [`method: BrowserContext.close`] for the HAR to be saved.", - "deprecated": false, + "comment": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into `recordHar.path` file.\nIf not specified, the HAR is not recorded. Make sure to await [`method: BrowserContext.close`] for the HAR to be\nsaved.", "async": false, "alias": "recordHar", "overloadIndex": 0, @@ -14398,12 +16087,11 @@ "spec": [ { "type": "text", - "text": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach` is specified, resources are persistet as separate files and all of these files are archived along with the HAR file. Defaults to `embed`, which stores content inline the HAR file as per HAR specification." + "text": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach` is specified, resources are persisted as separate files and all of these files are archived along with the HAR file. Defaults to `embed`, which stores content inline the HAR file as per HAR specification." } ], "required": false, - "comment": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach`\nis specified, resources are persistet as separate files and all of these files are archived along with the HAR file.\nDefaults to `embed`, which stores content inline the HAR file as per HAR specification.", - "deprecated": false, + "comment": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If\n`attach` is specified, resources are persisted as separate files and all of these files are archived along with the\nHAR file. Defaults to `embed`, which stores content inline the HAR file as per HAR specification.", "async": false, "alias": "recordHarContent", "overloadIndex": 0, @@ -14445,8 +16133,7 @@ } ], "required": false, - "comment": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies,\nsecurity and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.", - "deprecated": false, + "comment": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page,\ncookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.", "async": false, "alias": "recordHarMode", "overloadIndex": 0, @@ -14481,7 +16168,6 @@ ], "required": false, "comment": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`.", - "deprecated": false, "async": false, "alias": "recordHarOmitContent", "overloadIndex": 0, @@ -14511,12 +16197,11 @@ "spec": [ { "type": "text", - "text": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the specified HAR file on the filesystem. If not specified, the HAR is not recorded. Make sure to call [`method: BrowserContext.close`] for the HAR to be saved." + "text": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the↵specified HAR file on the filesystem. If not specified, the HAR is not recorded. Make sure to↵call [`method: BrowserContext.close`] for the HAR to be saved." } ], "required": false, - "comment": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the specified HAR file on the\nfilesystem. If not specified, the HAR is not recorded. Make sure to call [`method: BrowserContext.close`] for the HAR to\nbe saved.", - "deprecated": false, + "comment": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the specified HAR file\non the filesystem. If not specified, the HAR is not recorded. Make sure to call [`method: BrowserContext.close`]\nfor the HAR to be saved.", "async": false, "alias": "recordHarPath", "overloadIndex": 0, @@ -14554,7 +16239,6 @@ "spec": [], "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "recordHarUrlFilter", "overloadIndex": 0, @@ -14594,7 +16278,6 @@ ], "required": true, "comment": "Path to the directory to put videos into.", - "deprecated": false, "async": false, "alias": "dir", "overloadIndex": 0, @@ -14627,7 +16310,6 @@ ], "required": true, "comment": "Video frame width.", - "deprecated": false, "async": false, "alias": "width", "overloadIndex": 0, @@ -14651,7 +16333,6 @@ ], "required": true, "comment": "Video frame height.", - "deprecated": false, "async": false, "alias": "height", "overloadIndex": 0, @@ -14663,12 +16344,11 @@ "spec": [ { "type": "text", - "text": "Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size." + "text": "Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport`↵scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450.↵Actual picture of each page will be scaled down if necessary to fit the specified size." } ], "required": false, - "comment": "Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit\ninto 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page\nwill be scaled down if necessary to fit the specified size.", - "deprecated": false, + "comment": "Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to\nfit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of\neach page will be scaled down if necessary to fit the specified size.", "async": false, "alias": "size", "overloadIndex": 0, @@ -14680,12 +16360,11 @@ "spec": [ { "type": "text", - "text": "Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make sure to await [`method: BrowserContext.close`] for videos to be saved." + "text": "Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make↵sure to await [`method: BrowserContext.close`] for videos to be saved." } ], "required": false, - "comment": "Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make\nsure to await [`method: BrowserContext.close`] for videos to be saved.", - "deprecated": false, + "comment": "Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded.\nMake sure to await [`method: BrowserContext.close`] for videos to be saved.", "async": false, "alias": "recordVideo", "overloadIndex": 0, @@ -14715,12 +16394,11 @@ "spec": [ { "type": "text", - "text": "Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make sure to call [`method: BrowserContext.close`] for videos to be saved." + "text": "Enables video recording for all pages into the specified directory. If not specified videos are↵not recorded. Make sure to call [`method: BrowserContext.close`] for videos to be saved." } ], "required": false, - "comment": "Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make sure\nto call [`method: BrowserContext.close`] for videos to be saved.", - "deprecated": false, + "comment": "Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make\nsure to call [`method: BrowserContext.close`] for videos to be saved.", "async": false, "alias": "recordVideoDir", "overloadIndex": 0, @@ -14764,7 +16442,6 @@ ], "required": true, "comment": "Video frame width.", - "deprecated": false, "async": false, "alias": "width", "overloadIndex": 0, @@ -14788,7 +16465,6 @@ ], "required": true, "comment": "Video frame height.", - "deprecated": false, "async": false, "alias": "height", "overloadIndex": 0, @@ -14800,12 +16476,11 @@ "spec": [ { "type": "text", - "text": "Dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size." + "text": "Dimensions of the recorded videos. If not specified the size will be equal to `viewport`↵scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450.↵Actual picture of each page will be scaled down if necessary to fit the specified size." } ], "required": false, - "comment": "Dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit into\n800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page will\nbe scaled down if necessary to fit the specified size.", - "deprecated": false, + "comment": "Dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit into\n800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page\nwill be scaled down if necessary to fit the specified size.", "async": false, "alias": "recordVideoSize", "overloadIndex": 0, @@ -14813,7 +16488,62 @@ }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "js", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "reducedMotion", + "type": { + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "ReducedMotion", + "union": [ + { + "name": "\"reduce\"" + }, + { + "name": "\"no-preference\"" + } + ] + } + ], + "expression": "null|[ReducedMotion]<\"reduce\"|\"no-preference\">" + }, + "spec": [ + { + "type": "text", + "text": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See [`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to `'no-preference'`." + } + ], + "required": false, + "comment": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to\n`'no-preference'`.", + "async": false, + "alias": "reducedMotion", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, "since": "v1.8", "name": "reducedMotion", @@ -14825,19 +16555,21 @@ }, { "name": "\"no-preference\"" + }, + { + "name": "\"null\"" } ], - "expression": "[ReducedMotion]<\"reduce\"|\"no-preference\">" + "expression": "[ReducedMotion]<\"reduce\"|\"no-preference\"|\"null\">" }, "spec": [ { "type": "text", - "text": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See [`method: Page.emulateMedia`] for more details. Defaults to `'no-preference'`." + "text": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See [`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to `'no-preference'`." } ], "required": false, - "comment": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Defaults to `'no-preference'`.", - "deprecated": false, + "comment": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to\n`'no-preference'`.", "async": false, "alias": "reducedMotion", "overloadIndex": 0, @@ -14877,7 +16609,6 @@ ], "required": true, "comment": "page width in pixels.", - "deprecated": false, "async": false, "alias": "width", "overloadIndex": 0, @@ -14901,7 +16632,6 @@ ], "required": true, "comment": "page height in pixels.", - "deprecated": false, "async": false, "alias": "height", "overloadIndex": 0, @@ -14913,12 +16643,11 @@ "spec": [ { "type": "text", - "text": "Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the `viewport` is set." + "text": "Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the↵`viewport` is set." } ], "required": false, - "comment": "Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the `viewport`\nis set.", - "deprecated": false, + "comment": "Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the\n`viewport` is set.", "async": false, "alias": "screen", "overloadIndex": 0, @@ -14959,8 +16688,7 @@ } ], "required": false, - "comment": "Whether to allow sites to register Service workers. Defaults to `'allow'`.\n- `'allow'`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be registered.\n- `'block'`: Playwright will block all registration of Service Workers.", - "deprecated": false, + "comment": "Whether to allow sites to register Service workers. Defaults to `'allow'`.\n- `'allow'`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be\n registered.\n- `'block'`: Playwright will block all registration of Service Workers.", "async": false, "alias": "serviceWorkers", "overloadIndex": 0, @@ -15019,7 +16747,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "name", "overloadIndex": 0, @@ -15043,7 +16770,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "value", "overloadIndex": 0, @@ -15067,7 +16793,6 @@ ], "required": true, "comment": "domain and path are required", - "deprecated": false, "async": false, "alias": "domain", "overloadIndex": 0, @@ -15091,7 +16816,6 @@ ], "required": true, "comment": "domain and path are required", - "deprecated": false, "async": false, "alias": "path", "overloadIndex": 0, @@ -15115,7 +16839,6 @@ ], "required": true, "comment": "Unix time in seconds.", - "deprecated": false, "async": false, "alias": "expires", "overloadIndex": 0, @@ -15139,7 +16862,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "httpOnly", "overloadIndex": 0, @@ -15163,7 +16885,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "secure", "overloadIndex": 0, @@ -15198,7 +16919,6 @@ ], "required": true, "comment": "sameSite flag", - "deprecated": false, "async": false, "alias": "sameSite", "overloadIndex": 0, @@ -15217,7 +16937,6 @@ ], "required": true, "comment": "cookies to set for context", - "deprecated": false, "async": false, "alias": "cookies", "overloadIndex": 0, @@ -15253,7 +16972,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "origin", "overloadIndex": 0, @@ -15289,7 +17007,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "name", "overloadIndex": 0, @@ -15313,7 +17030,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "value", "overloadIndex": 0, @@ -15332,7 +17048,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "localStorage", "overloadIndex": 0, @@ -15351,7 +17066,6 @@ ], "required": true, "comment": "localStorage to set for context", - "deprecated": false, "async": false, "alias": "origins", "overloadIndex": 0, @@ -15365,12 +17079,11 @@ "spec": [ { "type": "text", - "text": "Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via [`method: BrowserContext.storageState`]. Either a path to the file with saved storage, or an object with the following fields:" + "text": "Populates context with given storage state. This option can be used to initialize context with logged-in information↵obtained via [`method: BrowserContext.storageState`]. Either a path to the file with saved storage, or an object with the following fields:" } ], "required": false, - "comment": "Populates context with given storage state. This option can be used to initialize context with logged-in information\nobtained via [`method: BrowserContext.storageState`]. Either a path to the file with saved storage, or an object with\nthe following fields:", - "deprecated": false, + "comment": "Populates context with given storage state. This option can be used to initialize context with logged-in\ninformation obtained via [`method: BrowserContext.storageState`]. Either a path to the file with saved storage, or\nan object with the following fields:", "async": false, "alias": "storageState", "overloadIndex": 0, @@ -15397,12 +17110,11 @@ "spec": [ { "type": "text", - "text": "Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via [`method: BrowserContext.storageState`]." + "text": "Populates context with given storage state. This option can be used to initialize context with logged-in information↵obtained via [`method: BrowserContext.storageState`]." } ], "required": false, - "comment": "Populates context with given storage state. This option can be used to initialize context with logged-in information\nobtained via [`method: BrowserContext.storageState`].", - "deprecated": false, + "comment": "Populates context with given storage state. This option can be used to initialize context with logged-in\ninformation obtained via [`method: BrowserContext.storageState`].", "async": false, "alias": "storageState", "overloadIndex": 0, @@ -15429,12 +17141,11 @@ "spec": [ { "type": "text", - "text": "Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via [`method: BrowserContext.storageState`]. Path to the file with saved storage state." + "text": "Populates context with given storage state. This option can be used to initialize context with logged-in information↵obtained via [`method: BrowserContext.storageState`]. Path to the file with saved storage state." } ], "required": false, - "comment": "Populates context with given storage state. This option can be used to initialize context with logged-in information\nobtained via [`method: BrowserContext.storageState`]. Path to the file with saved storage state.", - "deprecated": false, + "comment": "Populates context with given storage state. This option can be used to initialize context with logged-in\ninformation obtained via [`method: BrowserContext.storageState`]. Path to the file with saved storage state.", "async": false, "alias": "storageStatePath", "overloadIndex": 0, @@ -15453,12 +17164,11 @@ "spec": [ { "type": "text", - "text": "If specified, enables strict selectors mode for this context. In the strict selectors mode all operations on selectors that imply single target DOM element will throw when more than one element matches the selector. See `Locator` to learn more about the strict mode." + "text": "If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations↵on selectors that imply single target DOM element will throw when more than one element matches the selector.↵This option does not affect any Locator APIs (Locators are always strict).↵See `Locator` to learn more about the strict mode." } ], "required": false, - "comment": "If specified, enables strict selectors mode for this context. In the strict selectors mode all operations on selectors\nthat imply single target DOM element will throw when more than one element matches the selector. See `Locator` to learn\nmore about the strict mode.", - "deprecated": false, + "comment": "If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations on\nselectors that imply single target DOM element will throw when more than one element matches the selector. This\noption does not affect any Locator APIs (Locators are always strict). See `Locator` to learn more about the strict\nmode.", "async": false, "alias": "strictSelectors", "overloadIndex": 0, @@ -15477,12 +17187,11 @@ "spec": [ { "type": "text", - "text": "Changes the timezone of the context. See [ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1) for a list of supported timezone IDs." + "text": "Changes the timezone of the context. See [ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1)↵for a list of supported timezone IDs." } ], "required": false, "comment": "Changes the timezone of the context. See\n[ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1)\nfor a list of supported timezone IDs.", - "deprecated": false, "async": false, "alias": "timezoneId", "overloadIndex": 0, @@ -15506,7 +17215,6 @@ ], "required": false, "comment": "Specific user agent to use in this context.", - "deprecated": false, "async": false, "alias": "userAgent", "overloadIndex": 0, @@ -15524,6 +17232,7 @@ }, "experimental": false, "since": "v1.8", + "deprecated": "Use `recordVideo` instead.", "name": "videoSize", "type": { "name": "Object", @@ -15546,7 +17255,6 @@ ], "required": true, "comment": "Video frame width.", - "deprecated": false, "async": false, "alias": "width", "overloadIndex": 0, @@ -15570,7 +17278,6 @@ ], "required": true, "comment": "Video frame height.", - "deprecated": false, "async": false, "alias": "height", "overloadIndex": 0, @@ -15579,15 +17286,9 @@ ], "expression": "[Object]" }, - "spec": [ - { - "type": "text", - "text": "**DEPRECATED** Use `recordVideo` instead." - } - ], + "spec": [], "required": false, - "comment": "**DEPRECATED** Use `recordVideo` instead.", - "deprecated": true, + "comment": "", "async": false, "alias": "videoSize", "overloadIndex": 0, @@ -15605,20 +17306,15 @@ }, "experimental": false, "since": "v1.8", + "deprecated": "Use `recordVideo` instead.", "name": "videosPath", "type": { "name": "path", "expression": "[path]" }, - "spec": [ - { - "type": "text", - "text": "**DEPRECATED** Use `recordVideo` instead." - } - ], + "spec": [], "required": false, - "comment": "**DEPRECATED** Use `recordVideo` instead.", - "deprecated": true, + "comment": "", "async": false, "alias": "videosPath", "overloadIndex": 0, @@ -15667,7 +17363,6 @@ ], "required": true, "comment": "page width in pixels.", - "deprecated": false, "async": false, "alias": "width", "overloadIndex": 0, @@ -15691,7 +17386,6 @@ ], "required": true, "comment": "page height in pixels.", - "deprecated": false, "async": false, "alias": "height", "overloadIndex": 0, @@ -15705,12 +17399,16 @@ "spec": [ { "type": "text", - "text": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. `null` disables the default viewport." + "text": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport.↵Use `null` to disable the consistent viewport emulation." + }, + { + "type": "note", + "noteType": "note", + "text": "The `null` value opts out from the default presets, makes viewport depend on the↵host window size defined by the operating system. It makes the execution of the↵tests non-deterministic." } ], "required": false, - "comment": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. `null` disables the default viewport.", - "deprecated": false, + "comment": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use `null` to disable the consistent\nviewport emulation.\n\n**NOTE** The `null` value opts out from the default presets, makes viewport depend on the host window size defined\nby the operating system. It makes the execution of the tests non-deterministic.", "async": false, "alias": "viewport", "overloadIndex": 0, @@ -15758,96 +17456,6 @@ ], "required": true, "comment": "page width in pixels.", - "deprecated": false, - "async": false, - "alias": "width", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "height", - "type": { - "name": "int", - "expression": "[int]" - }, - "spec": [ - { - "type": "text", - "text": "page height in pixels." - } - ], - "required": true, - "comment": "page height in pixels.", - "deprecated": false, - "async": false, - "alias": "height", - "overloadIndex": 0, - "paramOrOption": null - } - ] - } - ], - "expression": "[null]|[Object]" - }, - "spec": [ - { - "type": "text", - "text": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use `ViewportSize.NoViewport` to disable the default viewport." - } - ], - "required": false, - "comment": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use `ViewportSize.NoViewport` to disable\nthe default viewport.", - "deprecated": false, - "async": false, - "alias": "viewport", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": { - "only": [ - "python" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.8", - "name": "viewport", - "type": { - "name": "", - "union": [ - { - "name": "null" - }, - { - "name": "Object", - "properties": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "width", - "type": { - "name": "int", - "expression": "[int]" - }, - "spec": [ - { - "type": "text", - "text": "page width in pixels." - } - ], - "required": true, - "comment": "page width in pixels.", - "deprecated": false, "async": false, "alias": "width", "overloadIndex": 0, @@ -15871,7 +17479,97 @@ ], "required": true, "comment": "page height in pixels.", - "deprecated": false, + "async": false, + "alias": "height", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ], + "expression": "[null]|[Object]" + }, + "spec": [ + { + "type": "text", + "text": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport.↵Use `ViewportSize.NoViewport` to disable the consistent viewport emulation." + }, + { + "type": "note", + "noteType": "note", + "text": "The `ViewportSize.NoViewport` value opts out from the default presets,↵makes viewport depend on the host window size defined by the operating system.↵It makes the execution of the tests non-deterministic." + } + ], + "required": false, + "comment": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use `ViewportSize.NoViewport` to\ndisable the consistent viewport emulation.\n\n**NOTE** The `ViewportSize.NoViewport` value opts out from the default presets, makes viewport depend on the host\nwindow size defined by the operating system. It makes the execution of the tests non-deterministic.", + "async": false, + "alias": "viewport", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "viewport", + "type": { + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "width", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "page width in pixels." + } + ], + "required": true, + "comment": "page width in pixels.", + "async": false, + "alias": "width", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "height", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "page height in pixels." + } + ], + "required": true, + "comment": "page height in pixels.", "async": false, "alias": "height", "overloadIndex": 0, @@ -15889,8 +17587,7 @@ } ], "required": false, - "comment": "Sets a consistent viewport for each page. Defaults to an 1280x720 viewport. `no_viewport` disables the fixed viewport.", - "deprecated": false, + "comment": "Sets a consistent viewport for each page. Defaults to an 1280x720 viewport. `no_viewport` disables the fixed\nviewport.", "async": false, "alias": "viewport", "overloadIndex": 0, @@ -15900,7 +17597,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -15925,12 +17621,11 @@ }, { "type": "text", - "text": "This is a convenience API that should only be used for the single-page scenarios and short snippets. Production code and testing frameworks should explicitly create [`method: Browser.newContext`] followed by the [`method: BrowserContext.newPage`] to control their exact life times." + "text": "This is a convenience API that should only be used for the single-page scenarios and short snippets. Production code and↵testing frameworks should explicitly create [`method: Browser.newContext`] followed by the↵[`method: BrowserContext.newPage`] to control their exact life times." } ], "required": true, - "comment": "Creates a new page in a new browser context. Closing this page will close the context as well.\n\nThis is a convenience API that should only be used for the single-page scenarios and short snippets. Production code and\ntesting frameworks should explicitly create [`method: Browser.newContext`] followed by the\n[`method: BrowserContext.newPage`] to control their exact life times.", - "deprecated": false, + "comment": "Creates a new page in a new browser context. Closing this page will close the context as well.\n\nThis is a convenience API that should only be used for the single-page scenarios and short snippets. Production\ncode and testing frameworks should explicitly create [`method: Browser.newContext`] followed by the\n[`method: BrowserContext.newPage`] to control their exact life times.", "async": true, "alias": "newPage", "overloadIndex": 0, @@ -15963,7 +17658,6 @@ ], "required": false, "comment": "Whether to automatically download all the attachments. Defaults to `true` where all the downloads are accepted.", - "deprecated": false, "async": false, "alias": "acceptDownloads", "overloadIndex": 0, @@ -16001,8 +17695,7 @@ } ], "required": false, - "comment": "When using [`method: Page.goto`], [`method: Page.route`], [`method: Page.waitForURL`], [`method: Page.waitForRequest`],\nor [`method: Page.waitForResponse`] it takes the base URL in consideration by using the\n[`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the corresponding URL.\nExamples:\n- baseURL: `http://localhost:3000` and navigating to `/bar.html` results in `http://localhost:3000/bar.html`\n- baseURL: `http://localhost:3000/foo/` and navigating to `./bar.html` results in `http://localhost:3000/foo/bar.html`\n- baseURL: `http://localhost:3000/foo` (without trailing slash) and navigating to `./bar.html` results in\n `http://localhost:3000/bar.html`", - "deprecated": false, + "comment": "When using [`method: Page.goto`], [`method: Page.route`], [`method: Page.waitForURL`],\n[`method: Page.waitForRequest`], or [`method: Page.waitForResponse`] it takes the base URL in consideration by\nusing the [`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the\ncorresponding URL. Examples:\n- baseURL: `http://localhost:3000` and navigating to `/bar.html` results in `http://localhost:3000/bar.html`\n- baseURL: `http://localhost:3000/foo/` and navigating to `./bar.html` results in\n `http://localhost:3000/foo/bar.html`\n- baseURL: `http://localhost:3000/foo` (without trailing slash) and navigating to `./bar.html` results in\n `http://localhost:3000/bar.html`", "async": false, "alias": "baseURL", "overloadIndex": 0, @@ -16026,7 +17719,6 @@ ], "required": false, "comment": "Toggles bypassing page's Content-Security-Policy.", - "deprecated": false, "async": false, "alias": "bypassCSP", "overloadIndex": 0, @@ -16034,7 +17726,65 @@ }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "js", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "colorScheme", + "type": { + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "ColorScheme", + "union": [ + { + "name": "\"light\"" + }, + { + "name": "\"dark\"" + }, + { + "name": "\"no-preference\"" + } + ] + } + ], + "expression": "null|[ColorScheme]<\"light\"|\"dark\"|\"no-preference\">" + }, + "spec": [ + { + "type": "text", + "text": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See↵[`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to `'light'`." + } + ], + "required": false, + "comment": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to\n`'light'`.", + "async": false, + "alias": "colorScheme", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, "since": "v1.8", "name": "colorScheme", @@ -16049,19 +17799,21 @@ }, { "name": "\"no-preference\"" + }, + { + "name": "\"null\"" } ], - "expression": "[ColorScheme]<\"light\"|\"dark\"|\"no-preference\">" + "expression": "[ColorScheme]<\"light\"|\"dark\"|\"no-preference\"|\"null\">" }, "spec": [ { "type": "text", - "text": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See [`method: Page.emulateMedia`] for more details. Defaults to `'light'`." + "text": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See↵[`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to `'light'`." } ], "required": false, - "comment": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Defaults to `'light'`.", - "deprecated": false, + "comment": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to\n`'light'`.", "async": false, "alias": "colorScheme", "overloadIndex": 0, @@ -16085,7 +17837,6 @@ ], "required": false, "comment": "Specify device scale factor (can be thought of as dpr). Defaults to `1`.", - "deprecated": false, "async": false, "alias": "deviceScaleFactor", "overloadIndex": 0, @@ -16117,7 +17868,6 @@ ], "required": false, "comment": "An object containing additional HTTP headers to be sent with every request.", - "deprecated": false, "async": false, "alias": "extraHTTPHeaders", "overloadIndex": 0, @@ -16125,7 +17875,62 @@ }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "js", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "forcedColors", + "type": { + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "ForcedColors", + "union": [ + { + "name": "\"active\"" + }, + { + "name": "\"none\"" + } + ] + } + ], + "expression": "null|[ForcedColors]<\"active\"|\"none\">" + }, + "spec": [ + { + "type": "text", + "text": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See [`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to `'none'`." + } + ], + "required": false, + "comment": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See\n[`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to\n`'none'`.", + "async": false, + "alias": "forcedColors", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, "since": "v1.8", "name": "forcedColors", @@ -16137,24 +17942,21 @@ }, { "name": "\"none\"" + }, + { + "name": "\"null\"" } ], - "expression": "[ForcedColors]<\"active\"|\"none\">" + "expression": "[ForcedColors]<\"active\"|\"none\"|\"null\">" }, "spec": [ { "type": "text", - "text": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See [`method: Page.emulateMedia`] for more details. Defaults to `'none'`." - }, - { - "type": "note", - "noteType": "note", - "text": "It's not supported in WebKit, see [here](https://bugs.webkit.org/show_bug.cgi?id=225281) in their issue tracker." + "text": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See [`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to `'none'`." } ], "required": false, - "comment": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See [`method: Page.emulateMedia`]\nfor more details. Defaults to `'none'`.\n\n> NOTE: It's not supported in WebKit, see [here](https://bugs.webkit.org/show_bug.cgi?id=225281) in their issue tracker.", - "deprecated": false, + "comment": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See\n[`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to\n`'none'`.", "async": false, "alias": "forcedColors", "overloadIndex": 0, @@ -16187,7 +17989,6 @@ ], "required": true, "comment": "Latitude between -90 and 90.", - "deprecated": false, "async": false, "alias": "latitude", "overloadIndex": 0, @@ -16211,7 +18012,6 @@ ], "required": true, "comment": "Longitude between -180 and 180.", - "deprecated": false, "async": false, "alias": "longitude", "overloadIndex": 0, @@ -16235,7 +18035,6 @@ ], "required": false, "comment": "Non-negative accuracy value. Defaults to `0`.", - "deprecated": false, "async": false, "alias": "accuracy", "overloadIndex": 0, @@ -16247,7 +18046,6 @@ "spec": [], "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "geolocation", "overloadIndex": 0, @@ -16271,7 +18069,6 @@ ], "required": false, "comment": "Specifies if viewport supports touch events. Defaults to false.", - "deprecated": false, "async": false, "alias": "hasTouch", "overloadIndex": 0, @@ -16304,7 +18101,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "username", "overloadIndex": 0, @@ -16328,7 +18124,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "password", "overloadIndex": 0, @@ -16345,7 +18140,6 @@ ], "required": false, "comment": "Credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication).", - "deprecated": false, "async": false, "alias": "httpCredentials", "overloadIndex": 0, @@ -16369,7 +18163,6 @@ ], "required": false, "comment": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.", - "deprecated": false, "async": false, "alias": "ignoreHTTPSErrors", "overloadIndex": 0, @@ -16388,12 +18181,11 @@ "spec": [ { "type": "text", - "text": "Whether the `meta viewport` tag is taken into account and touch events are enabled. Defaults to `false`. Not supported in Firefox." + "text": "Whether the `meta viewport` tag is taken into account and touch events are enabled. Defaults to `false`. Not supported↵in Firefox." } ], "required": false, - "comment": "Whether the `meta viewport` tag is taken into account and touch events are enabled. Defaults to `false`. Not supported\nin Firefox.", - "deprecated": false, + "comment": "Whether the `meta viewport` tag is taken into account and touch events are enabled. Defaults to `false`. Not\nsupported in Firefox.", "async": false, "alias": "isMobile", "overloadIndex": 0, @@ -16417,7 +18209,6 @@ ], "required": false, "comment": "Whether or not to enable JavaScript in the context. Defaults to `true`.", - "deprecated": false, "async": false, "alias": "javaScriptEnabled", "overloadIndex": 0, @@ -16436,12 +18227,11 @@ "spec": [ { "type": "text", - "text": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value, `Accept-Language` request header value as well as number and date formatting rules." + "text": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value, `Accept-Language`↵request header value as well as number and date formatting rules." } ], "required": false, - "comment": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value, `Accept-Language`\nrequest header value as well as number and date formatting rules.", - "deprecated": false, + "comment": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value,\n`Accept-Language` request header value as well as number and date formatting rules.", "async": false, "alias": "locale", "overloadIndex": 0, @@ -16472,7 +18262,6 @@ ], "required": false, "comment": "Logger sink for Playwright logging.", - "deprecated": false, "async": false, "alias": "logger", "overloadIndex": 0, @@ -16503,7 +18292,6 @@ ], "required": false, "comment": "Does not enforce fixed viewport, allows resizing window in the headed mode.", - "deprecated": false, "async": false, "alias": "noViewport", "overloadIndex": 0, @@ -16527,7 +18315,6 @@ ], "required": false, "comment": "Whether to emulate network being offline. Defaults to `false`.", - "deprecated": false, "async": false, "alias": "offline", "overloadIndex": 0, @@ -16551,12 +18338,11 @@ "spec": [ { "type": "text", - "text": "A list of permissions to grant to all pages in this context. See [`method: BrowserContext.grantPermissions`] for more details." + "text": "A list of permissions to grant to all pages in this context. See↵[`method: BrowserContext.grantPermissions`] for more details." } ], "required": false, - "comment": "A list of permissions to grant to all pages in this context. See [`method: BrowserContext.grantPermissions`] for more\ndetails.", - "deprecated": false, + "comment": "A list of permissions to grant to all pages in this context. See [`method: BrowserContext.grantPermissions`] for\nmore details.", "async": false, "alias": "permissions", "overloadIndex": 0, @@ -16584,12 +18370,11 @@ "spec": [ { "type": "text", - "text": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example `http://myproxy.com:3128` or `socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP proxy." + "text": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example↵`http://myproxy.com:3128` or `socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP proxy." } ], "required": true, "comment": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example `http://myproxy.com:3128` or\n`socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP proxy.", - "deprecated": false, "async": false, "alias": "server", "overloadIndex": 0, @@ -16613,7 +18398,6 @@ ], "required": false, "comment": "Optional comma-separated domains to bypass proxy, for example `\".com, chromium.org, .domain.com\"`.", - "deprecated": false, "async": false, "alias": "bypass", "overloadIndex": 0, @@ -16637,7 +18421,6 @@ ], "required": false, "comment": "Optional username to use if HTTP proxy requires authentication.", - "deprecated": false, "async": false, "alias": "username", "overloadIndex": 0, @@ -16661,7 +18444,6 @@ ], "required": false, "comment": "Optional password to use if HTTP proxy requires authentication.", - "deprecated": false, "async": false, "alias": "password", "overloadIndex": 0, @@ -16678,12 +18460,11 @@ { "type": "note", "noteType": "note", - "text": "For Chromium on Windows the browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example `launch({ proxy: { server: 'http://per-context' } })`." + "text": "For Chromium on Windows the browser needs to be launched with the global proxy for this option to work. If all↵contexts override the proxy, global proxy will be never used and can be any string, for example↵`launch({ proxy: { server: 'http://per-context' } })`." } ], "required": false, - "comment": "Network proxy settings to use with this context.\n\n> NOTE: For Chromium on Windows the browser needs to be launched with the global proxy for this option to work. If all\ncontexts override the proxy, global proxy will be never used and can be any string, for example `launch({ proxy: {\nserver: 'http://per-context' } })`.", - "deprecated": false, + "comment": "Network proxy settings to use with this context.\n\n**NOTE** For Chromium on Windows the browser needs to be launched with the global proxy for this option to work. If\nall contexts override the proxy, global proxy will be never used and can be any string, for example `launch({\nproxy: { server: 'http://per-context' } })`.", "async": false, "alias": "proxy", "overloadIndex": 0, @@ -16718,12 +18499,11 @@ "spec": [ { "type": "text", - "text": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`. Deprecated, use `content` policy instead." + "text": "Optional setting to control whether to omit request content from the HAR. Defaults to↵`false`. Deprecated, use `content` policy instead." } ], "required": false, - "comment": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`. Deprecated, use `content`\npolicy instead.", - "deprecated": false, + "comment": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`. Deprecated, use\n`content` policy instead.", "async": false, "alias": "omitContent", "overloadIndex": 0, @@ -16753,12 +18533,11 @@ "spec": [ { "type": "text", - "text": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach` is specified, resources are persistet as separate files or entries in the ZIP archive. If `embed` is specified, content is stored inline the HAR file as per HAR specification. Defaults to `attach` for `.zip` output files and to `embed` for all other file extensions." + "text": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach` is specified, resources are persisted as separate files or entries in the ZIP archive. If `embed` is specified, content is stored inline the HAR file as per HAR specification. Defaults to `attach` for `.zip` output files and to `embed` for all other file extensions." } ], "required": false, - "comment": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach`\nis specified, resources are persistet as separate files or entries in the ZIP archive. If `embed` is specified, content\nis stored inline the HAR file as per HAR specification. Defaults to `attach` for `.zip` output files and to `embed` for\nall other file extensions.", - "deprecated": false, + "comment": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If\n`attach` is specified, resources are persisted as separate files or entries in the ZIP archive. If `embed` is\nspecified, content is stored inline the HAR file as per HAR specification. Defaults to `attach` for `.zip` output\nfiles and to `embed` for all other file extensions.", "async": false, "alias": "content", "overloadIndex": 0, @@ -16782,7 +18561,6 @@ ], "required": true, "comment": "Path on the filesystem to write the HAR file to. If the file name ends with `.zip`, `content: 'attach'` is used by\ndefault.", - "deprecated": false, "async": false, "alias": "path", "overloadIndex": 0, @@ -16813,8 +18591,7 @@ } ], "required": false, - "comment": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies,\nsecurity and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.", - "deprecated": false, + "comment": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page,\ncookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.", "async": false, "alias": "mode", "overloadIndex": 0, @@ -16846,7 +18623,6 @@ ], "required": false, "comment": "A glob or regex pattern to filter requests that are stored in the HAR. When a `baseURL` via the context options was\nprovided and the passed URL is a path, it gets merged via the\n[`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor.", - "deprecated": false, "async": false, "alias": "urlFilter", "overloadIndex": 0, @@ -16858,12 +18634,11 @@ "spec": [ { "type": "text", - "text": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into `recordHar.path` file. If not specified, the HAR is not recorded. Make sure to await [`method: BrowserContext.close`] for the HAR to be saved." + "text": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into `recordHar.path` file. If not↵specified, the HAR is not recorded. Make sure to await [`method: BrowserContext.close`] for the HAR to be↵saved." } ], "required": false, - "comment": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into `recordHar.path` file. If not\nspecified, the HAR is not recorded. Make sure to await [`method: BrowserContext.close`] for the HAR to be saved.", - "deprecated": false, + "comment": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into `recordHar.path` file.\nIf not specified, the HAR is not recorded. Make sure to await [`method: BrowserContext.close`] for the HAR to be\nsaved.", "async": false, "alias": "recordHar", "overloadIndex": 0, @@ -16904,12 +18679,11 @@ "spec": [ { "type": "text", - "text": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach` is specified, resources are persistet as separate files and all of these files are archived along with the HAR file. Defaults to `embed`, which stores content inline the HAR file as per HAR specification." + "text": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach` is specified, resources are persisted as separate files and all of these files are archived along with the HAR file. Defaults to `embed`, which stores content inline the HAR file as per HAR specification." } ], "required": false, - "comment": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach`\nis specified, resources are persistet as separate files and all of these files are archived along with the HAR file.\nDefaults to `embed`, which stores content inline the HAR file as per HAR specification.", - "deprecated": false, + "comment": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If\n`attach` is specified, resources are persisted as separate files and all of these files are archived along with the\nHAR file. Defaults to `embed`, which stores content inline the HAR file as per HAR specification.", "async": false, "alias": "recordHarContent", "overloadIndex": 0, @@ -16951,8 +18725,7 @@ } ], "required": false, - "comment": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies,\nsecurity and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.", - "deprecated": false, + "comment": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page,\ncookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.", "async": false, "alias": "recordHarMode", "overloadIndex": 0, @@ -16987,7 +18760,6 @@ ], "required": false, "comment": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`.", - "deprecated": false, "async": false, "alias": "recordHarOmitContent", "overloadIndex": 0, @@ -17017,12 +18789,11 @@ "spec": [ { "type": "text", - "text": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the specified HAR file on the filesystem. If not specified, the HAR is not recorded. Make sure to call [`method: BrowserContext.close`] for the HAR to be saved." + "text": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the↵specified HAR file on the filesystem. If not specified, the HAR is not recorded. Make sure to↵call [`method: BrowserContext.close`] for the HAR to be saved." } ], "required": false, - "comment": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the specified HAR file on the\nfilesystem. If not specified, the HAR is not recorded. Make sure to call [`method: BrowserContext.close`] for the HAR to\nbe saved.", - "deprecated": false, + "comment": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the specified HAR file\non the filesystem. If not specified, the HAR is not recorded. Make sure to call [`method: BrowserContext.close`]\nfor the HAR to be saved.", "async": false, "alias": "recordHarPath", "overloadIndex": 0, @@ -17060,7 +18831,6 @@ "spec": [], "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "recordHarUrlFilter", "overloadIndex": 0, @@ -17100,7 +18870,6 @@ ], "required": true, "comment": "Path to the directory to put videos into.", - "deprecated": false, "async": false, "alias": "dir", "overloadIndex": 0, @@ -17133,7 +18902,6 @@ ], "required": true, "comment": "Video frame width.", - "deprecated": false, "async": false, "alias": "width", "overloadIndex": 0, @@ -17157,7 +18925,6 @@ ], "required": true, "comment": "Video frame height.", - "deprecated": false, "async": false, "alias": "height", "overloadIndex": 0, @@ -17169,12 +18936,11 @@ "spec": [ { "type": "text", - "text": "Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size." + "text": "Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport`↵scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450.↵Actual picture of each page will be scaled down if necessary to fit the specified size." } ], "required": false, - "comment": "Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit\ninto 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page\nwill be scaled down if necessary to fit the specified size.", - "deprecated": false, + "comment": "Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to\nfit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of\neach page will be scaled down if necessary to fit the specified size.", "async": false, "alias": "size", "overloadIndex": 0, @@ -17186,12 +18952,11 @@ "spec": [ { "type": "text", - "text": "Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make sure to await [`method: BrowserContext.close`] for videos to be saved." + "text": "Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make↵sure to await [`method: BrowserContext.close`] for videos to be saved." } ], "required": false, - "comment": "Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make\nsure to await [`method: BrowserContext.close`] for videos to be saved.", - "deprecated": false, + "comment": "Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded.\nMake sure to await [`method: BrowserContext.close`] for videos to be saved.", "async": false, "alias": "recordVideo", "overloadIndex": 0, @@ -17221,12 +18986,11 @@ "spec": [ { "type": "text", - "text": "Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make sure to call [`method: BrowserContext.close`] for videos to be saved." + "text": "Enables video recording for all pages into the specified directory. If not specified videos are↵not recorded. Make sure to call [`method: BrowserContext.close`] for videos to be saved." } ], "required": false, - "comment": "Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make sure\nto call [`method: BrowserContext.close`] for videos to be saved.", - "deprecated": false, + "comment": "Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make\nsure to call [`method: BrowserContext.close`] for videos to be saved.", "async": false, "alias": "recordVideoDir", "overloadIndex": 0, @@ -17270,7 +19034,6 @@ ], "required": true, "comment": "Video frame width.", - "deprecated": false, "async": false, "alias": "width", "overloadIndex": 0, @@ -17294,7 +19057,6 @@ ], "required": true, "comment": "Video frame height.", - "deprecated": false, "async": false, "alias": "height", "overloadIndex": 0, @@ -17306,12 +19068,11 @@ "spec": [ { "type": "text", - "text": "Dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size." + "text": "Dimensions of the recorded videos. If not specified the size will be equal to `viewport`↵scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450.↵Actual picture of each page will be scaled down if necessary to fit the specified size." } ], "required": false, - "comment": "Dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit into\n800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page will\nbe scaled down if necessary to fit the specified size.", - "deprecated": false, + "comment": "Dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit into\n800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page\nwill be scaled down if necessary to fit the specified size.", "async": false, "alias": "recordVideoSize", "overloadIndex": 0, @@ -17319,7 +19080,62 @@ }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "js", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "reducedMotion", + "type": { + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "ReducedMotion", + "union": [ + { + "name": "\"reduce\"" + }, + { + "name": "\"no-preference\"" + } + ] + } + ], + "expression": "null|[ReducedMotion]<\"reduce\"|\"no-preference\">" + }, + "spec": [ + { + "type": "text", + "text": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See [`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to `'no-preference'`." + } + ], + "required": false, + "comment": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to\n`'no-preference'`.", + "async": false, + "alias": "reducedMotion", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, "since": "v1.8", "name": "reducedMotion", @@ -17331,19 +19147,21 @@ }, { "name": "\"no-preference\"" + }, + { + "name": "\"null\"" } ], - "expression": "[ReducedMotion]<\"reduce\"|\"no-preference\">" + "expression": "[ReducedMotion]<\"reduce\"|\"no-preference\"|\"null\">" }, "spec": [ { "type": "text", - "text": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See [`method: Page.emulateMedia`] for more details. Defaults to `'no-preference'`." + "text": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See [`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to `'no-preference'`." } ], "required": false, - "comment": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Defaults to `'no-preference'`.", - "deprecated": false, + "comment": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to\n`'no-preference'`.", "async": false, "alias": "reducedMotion", "overloadIndex": 0, @@ -17383,7 +19201,6 @@ ], "required": true, "comment": "page width in pixels.", - "deprecated": false, "async": false, "alias": "width", "overloadIndex": 0, @@ -17407,7 +19224,6 @@ ], "required": true, "comment": "page height in pixels.", - "deprecated": false, "async": false, "alias": "height", "overloadIndex": 0, @@ -17419,12 +19235,11 @@ "spec": [ { "type": "text", - "text": "Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the `viewport` is set." + "text": "Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the↵`viewport` is set." } ], "required": false, - "comment": "Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the `viewport`\nis set.", - "deprecated": false, + "comment": "Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the\n`viewport` is set.", "async": false, "alias": "screen", "overloadIndex": 0, @@ -17465,8 +19280,7 @@ } ], "required": false, - "comment": "Whether to allow sites to register Service workers. Defaults to `'allow'`.\n- `'allow'`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be registered.\n- `'block'`: Playwright will block all registration of Service Workers.", - "deprecated": false, + "comment": "Whether to allow sites to register Service workers. Defaults to `'allow'`.\n- `'allow'`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be\n registered.\n- `'block'`: Playwright will block all registration of Service Workers.", "async": false, "alias": "serviceWorkers", "overloadIndex": 0, @@ -17525,7 +19339,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "name", "overloadIndex": 0, @@ -17549,7 +19362,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "value", "overloadIndex": 0, @@ -17573,7 +19385,6 @@ ], "required": true, "comment": "domain and path are required", - "deprecated": false, "async": false, "alias": "domain", "overloadIndex": 0, @@ -17597,7 +19408,6 @@ ], "required": true, "comment": "domain and path are required", - "deprecated": false, "async": false, "alias": "path", "overloadIndex": 0, @@ -17621,7 +19431,6 @@ ], "required": true, "comment": "Unix time in seconds.", - "deprecated": false, "async": false, "alias": "expires", "overloadIndex": 0, @@ -17645,7 +19454,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "httpOnly", "overloadIndex": 0, @@ -17669,7 +19477,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "secure", "overloadIndex": 0, @@ -17704,7 +19511,6 @@ ], "required": true, "comment": "sameSite flag", - "deprecated": false, "async": false, "alias": "sameSite", "overloadIndex": 0, @@ -17723,7 +19529,6 @@ ], "required": true, "comment": "cookies to set for context", - "deprecated": false, "async": false, "alias": "cookies", "overloadIndex": 0, @@ -17759,7 +19564,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "origin", "overloadIndex": 0, @@ -17795,7 +19599,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "name", "overloadIndex": 0, @@ -17819,7 +19622,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "value", "overloadIndex": 0, @@ -17838,7 +19640,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "localStorage", "overloadIndex": 0, @@ -17857,7 +19658,6 @@ ], "required": true, "comment": "localStorage to set for context", - "deprecated": false, "async": false, "alias": "origins", "overloadIndex": 0, @@ -17871,12 +19671,11 @@ "spec": [ { "type": "text", - "text": "Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via [`method: BrowserContext.storageState`]. Either a path to the file with saved storage, or an object with the following fields:" + "text": "Populates context with given storage state. This option can be used to initialize context with logged-in information↵obtained via [`method: BrowserContext.storageState`]. Either a path to the file with saved storage, or an object with the following fields:" } ], "required": false, - "comment": "Populates context with given storage state. This option can be used to initialize context with logged-in information\nobtained via [`method: BrowserContext.storageState`]. Either a path to the file with saved storage, or an object with\nthe following fields:", - "deprecated": false, + "comment": "Populates context with given storage state. This option can be used to initialize context with logged-in\ninformation obtained via [`method: BrowserContext.storageState`]. Either a path to the file with saved storage, or\nan object with the following fields:", "async": false, "alias": "storageState", "overloadIndex": 0, @@ -17903,12 +19702,11 @@ "spec": [ { "type": "text", - "text": "Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via [`method: BrowserContext.storageState`]." + "text": "Populates context with given storage state. This option can be used to initialize context with logged-in information↵obtained via [`method: BrowserContext.storageState`]." } ], "required": false, - "comment": "Populates context with given storage state. This option can be used to initialize context with logged-in information\nobtained via [`method: BrowserContext.storageState`].", - "deprecated": false, + "comment": "Populates context with given storage state. This option can be used to initialize context with logged-in\ninformation obtained via [`method: BrowserContext.storageState`].", "async": false, "alias": "storageState", "overloadIndex": 0, @@ -17935,12 +19733,11 @@ "spec": [ { "type": "text", - "text": "Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via [`method: BrowserContext.storageState`]. Path to the file with saved storage state." + "text": "Populates context with given storage state. This option can be used to initialize context with logged-in information↵obtained via [`method: BrowserContext.storageState`]. Path to the file with saved storage state." } ], "required": false, - "comment": "Populates context with given storage state. This option can be used to initialize context with logged-in information\nobtained via [`method: BrowserContext.storageState`]. Path to the file with saved storage state.", - "deprecated": false, + "comment": "Populates context with given storage state. This option can be used to initialize context with logged-in\ninformation obtained via [`method: BrowserContext.storageState`]. Path to the file with saved storage state.", "async": false, "alias": "storageStatePath", "overloadIndex": 0, @@ -17959,12 +19756,11 @@ "spec": [ { "type": "text", - "text": "If specified, enables strict selectors mode for this context. In the strict selectors mode all operations on selectors that imply single target DOM element will throw when more than one element matches the selector. See `Locator` to learn more about the strict mode." + "text": "If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations↵on selectors that imply single target DOM element will throw when more than one element matches the selector.↵This option does not affect any Locator APIs (Locators are always strict).↵See `Locator` to learn more about the strict mode." } ], "required": false, - "comment": "If specified, enables strict selectors mode for this context. In the strict selectors mode all operations on selectors\nthat imply single target DOM element will throw when more than one element matches the selector. See `Locator` to learn\nmore about the strict mode.", - "deprecated": false, + "comment": "If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations on\nselectors that imply single target DOM element will throw when more than one element matches the selector. This\noption does not affect any Locator APIs (Locators are always strict). See `Locator` to learn more about the strict\nmode.", "async": false, "alias": "strictSelectors", "overloadIndex": 0, @@ -17983,12 +19779,11 @@ "spec": [ { "type": "text", - "text": "Changes the timezone of the context. See [ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1) for a list of supported timezone IDs." + "text": "Changes the timezone of the context. See [ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1)↵for a list of supported timezone IDs." } ], "required": false, "comment": "Changes the timezone of the context. See\n[ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1)\nfor a list of supported timezone IDs.", - "deprecated": false, "async": false, "alias": "timezoneId", "overloadIndex": 0, @@ -18012,7 +19807,6 @@ ], "required": false, "comment": "Specific user agent to use in this context.", - "deprecated": false, "async": false, "alias": "userAgent", "overloadIndex": 0, @@ -18030,6 +19824,7 @@ }, "experimental": false, "since": "v1.8", + "deprecated": "Use `recordVideo` instead.", "name": "videoSize", "type": { "name": "Object", @@ -18052,7 +19847,6 @@ ], "required": true, "comment": "Video frame width.", - "deprecated": false, "async": false, "alias": "width", "overloadIndex": 0, @@ -18076,7 +19870,6 @@ ], "required": true, "comment": "Video frame height.", - "deprecated": false, "async": false, "alias": "height", "overloadIndex": 0, @@ -18085,15 +19878,9 @@ ], "expression": "[Object]" }, - "spec": [ - { - "type": "text", - "text": "**DEPRECATED** Use `recordVideo` instead." - } - ], + "spec": [], "required": false, - "comment": "**DEPRECATED** Use `recordVideo` instead.", - "deprecated": true, + "comment": "", "async": false, "alias": "videoSize", "overloadIndex": 0, @@ -18111,20 +19898,15 @@ }, "experimental": false, "since": "v1.8", + "deprecated": "Use `recordVideo` instead.", "name": "videosPath", "type": { "name": "path", "expression": "[path]" }, - "spec": [ - { - "type": "text", - "text": "**DEPRECATED** Use `recordVideo` instead." - } - ], + "spec": [], "required": false, - "comment": "**DEPRECATED** Use `recordVideo` instead.", - "deprecated": true, + "comment": "", "async": false, "alias": "videosPath", "overloadIndex": 0, @@ -18173,7 +19955,6 @@ ], "required": true, "comment": "page width in pixels.", - "deprecated": false, "async": false, "alias": "width", "overloadIndex": 0, @@ -18197,7 +19978,6 @@ ], "required": true, "comment": "page height in pixels.", - "deprecated": false, "async": false, "alias": "height", "overloadIndex": 0, @@ -18211,12 +19991,16 @@ "spec": [ { "type": "text", - "text": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. `null` disables the default viewport." + "text": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport.↵Use `null` to disable the consistent viewport emulation." + }, + { + "type": "note", + "noteType": "note", + "text": "The `null` value opts out from the default presets, makes viewport depend on the↵host window size defined by the operating system. It makes the execution of the↵tests non-deterministic." } ], "required": false, - "comment": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. `null` disables the default viewport.", - "deprecated": false, + "comment": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use `null` to disable the consistent\nviewport emulation.\n\n**NOTE** The `null` value opts out from the default presets, makes viewport depend on the host window size defined\nby the operating system. It makes the execution of the tests non-deterministic.", "async": false, "alias": "viewport", "overloadIndex": 0, @@ -18264,7 +20048,6 @@ ], "required": true, "comment": "page width in pixels.", - "deprecated": false, "async": false, "alias": "width", "overloadIndex": 0, @@ -18288,7 +20071,6 @@ ], "required": true, "comment": "page height in pixels.", - "deprecated": false, "async": false, "alias": "height", "overloadIndex": 0, @@ -18302,12 +20084,16 @@ "spec": [ { "type": "text", - "text": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use `ViewportSize.NoViewport` to disable the default viewport." + "text": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport.↵Use `ViewportSize.NoViewport` to disable the consistent viewport emulation." + }, + { + "type": "note", + "noteType": "note", + "text": "The `ViewportSize.NoViewport` value opts out from the default presets,↵makes viewport depend on the host window size defined by the operating system.↵It makes the execution of the tests non-deterministic." } ], "required": false, - "comment": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use `ViewportSize.NoViewport` to disable\nthe default viewport.", - "deprecated": false, + "comment": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use `ViewportSize.NoViewport` to\ndisable the consistent viewport emulation.\n\n**NOTE** The `ViewportSize.NoViewport` value opts out from the default presets, makes viewport depend on the host\nwindow size defined by the operating system. It makes the execution of the tests non-deterministic.", "async": false, "alias": "viewport", "overloadIndex": 0, @@ -18353,7 +20139,6 @@ ], "required": true, "comment": "page width in pixels.", - "deprecated": false, "async": false, "alias": "width", "overloadIndex": 0, @@ -18377,7 +20162,6 @@ ], "required": true, "comment": "page height in pixels.", - "deprecated": false, "async": false, "alias": "height", "overloadIndex": 0, @@ -18395,8 +20179,7 @@ } ], "required": false, - "comment": "Sets a consistent viewport for each page. Defaults to an 1280x720 viewport. `no_viewport` disables the fixed viewport.", - "deprecated": false, + "comment": "Sets a consistent viewport for each page. Defaults to an 1280x720 viewport. `no_viewport` disables the fixed\nviewport.", "async": false, "alias": "viewport", "overloadIndex": 0, @@ -18406,7 +20189,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -18440,7 +20222,11 @@ }, { "type": "text", - "text": "You can use [`method: Browser.startTracing`] and [`method: Browser.stopTracing`] to create a trace file that can be opened in Chrome DevTools performance panel." + "text": "You can use [`method: Browser.startTracing`] and [`method: Browser.stopTracing`] to create a trace file that can↵be opened in Chrome DevTools performance panel." + }, + { + "type": "text", + "text": "**Usage**" }, { "type": "code", @@ -18481,8 +20267,7 @@ } ], "required": true, - "comment": "> NOTE: This API controls [Chromium Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool)\nwhich is a low-level chromium-specific debugging tool. API to control [Playwright Tracing](../trace-viewer) could be\nfound [here](./class-tracing).\n\nYou can use [`method: Browser.startTracing`] and [`method: Browser.stopTracing`] to create a trace file that can be\nopened in Chrome DevTools performance panel.\n\n```js\nawait browser.startTracing(page, {path: 'trace.json'});\nawait page.goto('https://www.google.com');\nawait browser.stopTracing();\n```\n\n```java\nbrowser.startTracing(page, new Browser.StartTracingOptions()\n .setPath(Paths.get(\"trace.json\")));\npage.goto('https://www.google.com');\nbrowser.stopTracing();\n```\n\n```python async\nawait browser.start_tracing(page, path=\"trace.json\")\nawait page.goto(\"https://www.google.com\")\nawait browser.stop_tracing()\n```\n\n```python sync\nbrowser.start_tracing(page, path=\"trace.json\")\npage.goto(\"https://www.google.com\")\nbrowser.stop_tracing()\n```\n", - "deprecated": false, + "comment": "**NOTE** This API controls\n[Chromium Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool) which is a low-level\nchromium-specific debugging tool. API to control [Playwright Tracing](../trace-viewer) could be found\n[here](./class-tracing).\n\nYou can use [`method: Browser.startTracing`] and [`method: Browser.stopTracing`] to create a trace file that can be\nopened in Chrome DevTools performance panel.\n\n**Usage**\n\n```js\nawait browser.startTracing(page, {path: 'trace.json'});\nawait page.goto('https://www.google.com');\nawait browser.stopTracing();\n```\n\n```java\nbrowser.startTracing(page, new Browser.StartTracingOptions()\n .setPath(Paths.get(\"trace.json\")));\npage.goto('https://www.google.com');\nbrowser.stopTracing();\n```\n\n```py\nawait browser.start_tracing(page, path=\"trace.json\")\nawait page.goto(\"https://www.google.com\")\nawait browser.stop_tracing()\n```\n\n```py\nbrowser.start_tracing(page, path=\"trace.json\")\npage.goto(\"https://www.google.com\")\nbrowser.stop_tracing()\n```\n", "async": true, "alias": "startTracing", "overloadIndex": 0, @@ -18506,7 +20291,6 @@ ], "required": false, "comment": "Optional, if specified, tracing includes screenshots of the given page.", - "deprecated": false, "async": false, "alias": "page", "overloadIndex": 0, @@ -18544,7 +20328,6 @@ ], "required": false, "comment": "specify custom categories to use instead of default.", - "deprecated": false, "async": false, "alias": "categories", "overloadIndex": 0, @@ -18568,7 +20351,6 @@ ], "required": false, "comment": "A path to write the trace file to.", - "deprecated": false, "async": false, "alias": "path", "overloadIndex": 0, @@ -18592,7 +20374,6 @@ ], "required": false, "comment": "captures screenshots in the trace.", - "deprecated": false, "async": false, "alias": "screenshots", "overloadIndex": 0, @@ -18602,7 +20383,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -18641,8 +20421,7 @@ } ], "required": true, - "comment": "> NOTE: This API controls [Chromium Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool)\nwhich is a low-level chromium-specific debugging tool. API to control [Playwright Tracing](../trace-viewer) could be\nfound [here](./class-tracing).\n\nReturns the buffer with trace data.", - "deprecated": false, + "comment": "**NOTE** This API controls\n[Chromium Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool) which is a low-level\nchromium-specific debugging tool. API to control [Playwright Tracing](../trace-viewer) could be found\n[here](./class-tracing).\n\nReturns the buffer with trace data.", "async": true, "alias": "stopTracing", "overloadIndex": 0, @@ -18667,7 +20446,6 @@ ], "required": true, "comment": "Returns the browser version.", - "deprecated": false, "async": false, "alias": "version", "overloadIndex": 0, @@ -18690,11 +20468,11 @@ }, { "type": "text", - "text": "If a page opens another page, e.g. with a `window.open` call, the popup will belong to the parent page's browser context." + "text": "If a page opens another page, e.g. with a `window.open` call, the popup will belong to the parent page's browser↵context." }, { "type": "text", - "text": "Playwright allows creating \"incognito\" browser contexts with [`method: Browser.newContext`] method. \"Incognito\" browser contexts don't write any browsing data to disk." + "text": "Playwright allows creating \"incognito\" browser contexts with [`method: Browser.newContext`] method. \"Incognito\" browser↵contexts don't write any browsing data to disk." }, { "type": "code", @@ -18752,7 +20530,7 @@ "type": "code", "lines": [ "using var playwright = await Playwright.CreateAsync();", - "var browser = await playwright.Firefox.LaunchAsync(new BrowserTypeLaunchOptions { Headless = false });", + "var browser = await playwright.Firefox.LaunchAsync(new() { Headless = false });", "// Create a new incognito browser context", "var context = await browser.NewContextAsync();", "// Create a new page inside context.", @@ -18766,7 +20544,8 @@ ], "extends": "EventEmitter", "langs": {}, - "comment": "- extends: [EventEmitter]\n\nBrowserContexts provide a way to operate multiple independent browser sessions.\n\nIf a page opens another page, e.g. with a `window.open` call, the popup will belong to the parent page's browser\ncontext.\n\nPlaywright allows creating \"incognito\" browser contexts with [`method: Browser.newContext`] method. \"Incognito\" browser\ncontexts don't write any browsing data to disk.\n\n```js\n// Create a new incognito browser context\nconst context = await browser.newContext();\n// Create a new page inside context.\nconst page = await context.newPage();\nawait page.goto('https://example.com');\n// Dispose context once it's no longer needed.\nawait context.close();\n```\n\n```java\n// Create a new incognito browser context\nBrowserContext context = browser.newContext();\n// Create a new page inside context.\nPage page = context.newPage();\npage.navigate(\"https://example.com\");\n// Dispose context once it is no longer needed.\ncontext.close();\n```\n\n```python async\n# create a new incognito browser context\ncontext = await browser.new_context()\n# create a new page inside context.\npage = await context.new_page()\nawait page.goto(\"https://example.com\")\n# dispose context once it is no longer needed.\nawait context.close()\n```\n\n```python sync\n# create a new incognito browser context\ncontext = browser.new_context()\n# create a new page inside context.\npage = context.new_page()\npage.goto(\"https://example.com\")\n# dispose context once it is no longer needed.\ncontext.close()\n```\n\n```csharp\nusing var playwright = await Playwright.CreateAsync();\nvar browser = await playwright.Firefox.LaunchAsync(new BrowserTypeLaunchOptions { Headless = false });\n// Create a new incognito browser context\nvar context = await browser.NewContextAsync();\n// Create a new page inside context.\nvar page = await context.NewPageAsync();\nawait page.GotoAsync(\"https://bing.com\");\n// Dispose context once it is no longer needed.\nawait context.CloseAsync();\n```\n", + "comment": "- extends: [EventEmitter]\n\nBrowserContexts provide a way to operate multiple independent browser sessions.\n\nIf a page opens another page, e.g. with a `window.open` call, the popup will belong to the parent page's browser\ncontext.\n\nPlaywright allows creating \"incognito\" browser contexts with [`method: Browser.newContext`] method. \"Incognito\"\nbrowser contexts don't write any browsing data to disk.\n\n```js\n// Create a new incognito browser context\nconst context = await browser.newContext();\n// Create a new page inside context.\nconst page = await context.newPage();\nawait page.goto('https://example.com');\n// Dispose context once it's no longer needed.\nawait context.close();\n```\n\n```java\n// Create a new incognito browser context\nBrowserContext context = browser.newContext();\n// Create a new page inside context.\nPage page = context.newPage();\npage.navigate(\"https://example.com\");\n// Dispose context once it is no longer needed.\ncontext.close();\n```\n\n```py\n# create a new incognito browser context\ncontext = await browser.new_context()\n# create a new page inside context.\npage = await context.new_page()\nawait page.goto(\"https://example.com\")\n# dispose context once it is no longer needed.\nawait context.close()\n```\n\n```py\n# create a new incognito browser context\ncontext = browser.new_context()\n# create a new page inside context.\npage = context.new_page()\npage.goto(\"https://example.com\")\n# dispose context once it is no longer needed.\ncontext.close()\n```\n\n```csharp\nusing var playwright = await Playwright.CreateAsync();\nvar browser = await playwright.Firefox.LaunchAsync(new() { Headless = false });\n// Create a new incognito browser context\nvar context = await browser.NewContextAsync();\n// Create a new page inside context.\nvar page = await context.NewPageAsync();\nawait page.GotoAsync(\"https://bing.com\");\n// Dispose context once it is no longer needed.\nawait context.CloseAsync();\n```\n", + "since": "v1.8", "members": [ { "kind": "event", @@ -18819,8 +20598,7 @@ } ], "required": true, - "comment": "> NOTE: Only works with Chromium browser's persistent context.\n\nEmitted when new background page is created in the context.\n\n```js\nconst backgroundPage = await context.waitForEvent('backgroundpage');\n```\n\n```python async\nbackground_page = await context.wait_for_event(\"backgroundpage\")\n```\n\n```python sync\nbackground_page = context.wait_for_event(\"backgroundpage\")\n```\n", - "deprecated": false, + "comment": "**NOTE** Only works with Chromium browser's persistent context.\n\nEmitted when new background page is created in the context.\n\n```js\nconst backgroundPage = await context.waitForEvent('backgroundpage');\n```\n\n```py\nbackground_page = await context.wait_for_event(\"backgroundpage\")\n```\n\n```py\nbackground_page = context.wait_for_event(\"backgroundpage\")\n```\n", "async": false, "alias": "backgroundPage", "overloadIndex": 0, @@ -18860,7 +20638,6 @@ ], "required": true, "comment": "Emitted when Browser context gets closed. This might happen because of one of the following:\n- Browser context is closed.\n- Browser application is closed or crashed.\n- The [`method: Browser.close`] method was called.", - "deprecated": false, "async": false, "alias": "close", "overloadIndex": 0, @@ -18880,19 +20657,18 @@ "spec": [ { "type": "text", - "text": "The event is emitted when a new Page is created in the BrowserContext. The page may still be loading. The event will also fire for popup pages. See also [`event: Page.popup`] to receive events about popups relevant to a specific page." + "text": "The event is emitted when a new Page is created in the BrowserContext. The page may still be loading. The event will↵also fire for popup pages. See also [`event: Page.popup`] to receive events about popups relevant to a specific page." }, { "type": "text", - "text": "The earliest moment that page is available is when it has navigated to the initial url. For example, when opening a popup with `window.open('http://example.com')`, this event will fire when the network request to \"http://example.com\" is done and its response has started loading in the popup." + "text": "The earliest moment that page is available is when it has navigated to the initial url. For example, when opening a↵popup with `window.open('http://example.com')`, this event will fire when the network request to \"http://example.com\" is↵done and its response has started loading in the popup." }, { "type": "code", "lines": [ - "const [newPage] = await Promise.all([", - " context.waitForEvent('page'),", - " page.locator('a[target=_blank]').click(),", - "]);", + "const newPagePromise = context.waitForEvent('page');", + "await page.getByText('open new page').click();", + "const newPage = await newPagePromise;", "console.log(await newPage.evaluate('location.href'));" ], "codeLang": "js" @@ -18901,7 +20677,7 @@ "type": "code", "lines": [ "Page newPage = context.waitForPage(() -> {", - " page.locator(\"a[target=_blank]\").click();", + " page.getByText(\"open new page\").click();", "});", "System.out.println(newPage.evaluate(\"location.href\"));" ], @@ -18911,7 +20687,7 @@ "type": "code", "lines": [ "async with context.expect_page() as page_info:", - " await page.locator(\"a[target=_blank]\").click(),", + " await page.get_by_text(\"open new page\").click(),", "page = await page_info.value", "print(await page.evaluate(\"location.href\"))" ], @@ -18921,7 +20697,7 @@ "type": "code", "lines": [ "with context.expect_page() as page_info:", - " page.locator(\"a[target=_blank]\").click(),", + " page.get_by_text(\"open new page\").click(),", "page = page_info.value", "print(page.evaluate(\"location.href\"))" ], @@ -18932,7 +20708,7 @@ "lines": [ "var popup = await context.RunAndWaitForPageAsync(async =>", "{", - " await page.Locator(\"a\").ClickAsync();", + " await page.GetByText(\"open new page\").ClickAsync();", "});", "Console.WriteLine(await popup.EvaluateAsync(\"location.href\"));" ], @@ -18941,12 +20717,11 @@ { "type": "note", "noteType": "note", - "text": "Use [`method: Page.waitForLoadState`] to wait until the page gets to a particular state (you should not need it in most cases)." + "text": "Use [`method: Page.waitForLoadState`] to wait until the page gets to a particular state (you should not need it in most↵cases)." } ], "required": true, - "comment": "The event is emitted when a new Page is created in the BrowserContext. The page may still be loading. The event will\nalso fire for popup pages. See also [`event: Page.popup`] to receive events about popups relevant to a specific page.\n\nThe earliest moment that page is available is when it has navigated to the initial url. For example, when opening a\npopup with `window.open('http://example.com')`, this event will fire when the network request to \"http://example.com\" is\ndone and its response has started loading in the popup.\n\n```js\nconst [newPage] = await Promise.all([\n context.waitForEvent('page'),\n page.locator('a[target=_blank]').click(),\n]);\nconsole.log(await newPage.evaluate('location.href'));\n```\n\n```java\nPage newPage = context.waitForPage(() -> {\n page.locator(\"a[target=_blank]\").click();\n});\nSystem.out.println(newPage.evaluate(\"location.href\"));\n```\n\n```python async\nasync with context.expect_page() as page_info:\n await page.locator(\"a[target=_blank]\").click(),\npage = await page_info.value\nprint(await page.evaluate(\"location.href\"))\n```\n\n```python sync\nwith context.expect_page() as page_info:\n page.locator(\"a[target=_blank]\").click(),\npage = page_info.value\nprint(page.evaluate(\"location.href\"))\n```\n\n```csharp\nvar popup = await context.RunAndWaitForPageAsync(async =>\n{\n await page.Locator(\"a\").ClickAsync();\n});\nConsole.WriteLine(await popup.EvaluateAsync(\"location.href\"));\n```\n\n> NOTE: Use [`method: Page.waitForLoadState`] to wait until the page gets to a particular state (you should not need it\nin most cases).", - "deprecated": false, + "comment": "The event is emitted when a new Page is created in the BrowserContext. The page may still be loading. The event\nwill also fire for popup pages. See also [`event: Page.popup`] to receive events about popups relevant to a\nspecific page.\n\nThe earliest moment that page is available is when it has navigated to the initial url. For example, when opening a\npopup with `window.open('http://example.com')`, this event will fire when the network request to\n\"http://example.com\" is done and its response has started loading in the popup.\n\n```js\nconst newPagePromise = context.waitForEvent('page');\nawait page.getByText('open new page').click();\nconst newPage = await newPagePromise;\nconsole.log(await newPage.evaluate('location.href'));\n```\n\n```java\nPage newPage = context.waitForPage(() -> {\n page.getByText(\"open new page\").click();\n});\nSystem.out.println(newPage.evaluate(\"location.href\"));\n```\n\n```py\nasync with context.expect_page() as page_info:\n await page.get_by_text(\"open new page\").click(),\npage = await page_info.value\nprint(await page.evaluate(\"location.href\"))\n```\n\n```py\nwith context.expect_page() as page_info:\n page.get_by_text(\"open new page\").click(),\npage = page_info.value\nprint(page.evaluate(\"location.href\"))\n```\n\n```csharp\nvar popup = await context.RunAndWaitForPageAsync(async =>\n{\n await page.GetByText(\"open new page\").ClickAsync();\n});\nConsole.WriteLine(await popup.EvaluateAsync(\"location.href\"));\n```\n\n**NOTE** Use [`method: Page.waitForLoadState`] to wait until the page gets to a particular state (you should not\nneed it in most cases).", "async": false, "alias": "page", "overloadIndex": 0, @@ -18966,16 +20741,15 @@ "spec": [ { "type": "text", - "text": "Emitted when a request is issued from any pages created through this context. The [request] object is read-only. To only listen for requests from a particular page, use [`event: Page.request`]." + "text": "Emitted when a request is issued from any pages created through this context.↵The [request] object is read-only. To only listen for requests from a particular↵page, use [`event: Page.request`]." }, { "type": "text", - "text": "In order to intercept and mutate requests, see [`method: BrowserContext.route`] or [`method: Page.route`]." + "text": "In order to intercept and mutate requests, see [`method: BrowserContext.route`]↵or [`method: Page.route`]." } ], "required": true, - "comment": "Emitted when a request is issued from any pages created through this context. The [request] object is read-only. To only\nlisten for requests from a particular page, use [`event: Page.request`].\n\nIn order to intercept and mutate requests, see [`method: BrowserContext.route`] or [`method: Page.route`].", - "deprecated": false, + "comment": "Emitted when a request is issued from any pages created through this context. The [request] object is read-only. To\nonly listen for requests from a particular page, use [`event: Page.request`].\n\nIn order to intercept and mutate requests, see [`method: BrowserContext.route`] or [`method: Page.route`].", "async": false, "alias": "request", "overloadIndex": 0, @@ -18995,17 +20769,16 @@ "spec": [ { "type": "text", - "text": "Emitted when a request fails, for example by timing out. To only listen for failed requests from a particular page, use [`event: Page.requestFailed`]." + "text": "Emitted when a request fails, for example by timing out. To only listen for↵failed requests from a particular page, use [`event: Page.requestFailed`]." }, { "type": "note", "noteType": "note", - "text": "HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with [`event: BrowserContext.requestFinished`] event and not with [`event: BrowserContext.requestFailed`]." + "text": "HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete↵with [`event: BrowserContext.requestFinished`] event and not with [`event: BrowserContext.requestFailed`]." } ], "required": true, - "comment": "Emitted when a request fails, for example by timing out. To only listen for failed requests from a particular page, use\n[`event: Page.requestFailed`].\n\n> NOTE: HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will\ncomplete with [`event: BrowserContext.requestFinished`] event and not with [`event: BrowserContext.requestFailed`].", - "deprecated": false, + "comment": "Emitted when a request fails, for example by timing out. To only listen for failed requests from a particular page,\nuse [`event: Page.requestFailed`].\n\n**NOTE** HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request\nwill complete with [`event: BrowserContext.requestFinished`] event and not with\n[`event: BrowserContext.requestFailed`].", "async": false, "alias": "requestFailed", "overloadIndex": 0, @@ -19025,12 +20798,11 @@ "spec": [ { "type": "text", - "text": "Emitted when a request finishes successfully after downloading the response body. For a successful response, the sequence of events is `request`, `response` and `requestfinished`. To listen for successful requests from a particular page, use [`event: Page.requestFinished`]." + "text": "Emitted when a request finishes successfully after downloading the response body. For a successful response, the↵sequence of events is `request`, `response` and `requestfinished`. To listen for↵successful requests from a particular page, use [`event: Page.requestFinished`]." } ], "required": true, - "comment": "Emitted when a request finishes successfully after downloading the response body. For a successful response, the\nsequence of events is `request`, `response` and `requestfinished`. To listen for successful requests from a particular\npage, use [`event: Page.requestFinished`].", - "deprecated": false, + "comment": "Emitted when a request finishes successfully after downloading the response body. For a successful response, the\nsequence of events is `request`, `response` and `requestfinished`. To listen for successful requests from a\nparticular page, use [`event: Page.requestFinished`].", "async": false, "alias": "requestFinished", "overloadIndex": 0, @@ -19050,12 +20822,11 @@ "spec": [ { "type": "text", - "text": "Emitted when [response] status and headers are received for a request. For a successful response, the sequence of events is `request`, `response` and `requestfinished`. To listen for response events from a particular page, use [`event: Page.response`]." + "text": "Emitted when [response] status and headers are received for a request. For a successful response, the sequence of events↵is `request`, `response` and `requestfinished`. To listen for response events↵from a particular page, use [`event: Page.response`]." } ], "required": true, - "comment": "Emitted when [response] status and headers are received for a request. For a successful response, the sequence of events\nis `request`, `response` and `requestfinished`. To listen for response events from a particular page, use\n[`event: Page.response`].", - "deprecated": false, + "comment": "Emitted when [response] status and headers are received for a request. For a successful response, the sequence of\nevents is `request`, `response` and `requestfinished`. To listen for response events from a particular page, use\n[`event: Page.response`].", "async": false, "alias": "response", "overloadIndex": 0, @@ -19092,8 +20863,7 @@ } ], "required": true, - "comment": "> NOTE: Service workers are only supported on Chromium-based browsers.\n\nEmitted when new service worker is created in the context.", - "deprecated": false, + "comment": "**NOTE** Service workers are only supported on Chromium-based browsers.\n\nEmitted when new service worker is created in the context.", "async": false, "alias": "serviceWorker", "overloadIndex": 0, @@ -19112,7 +20882,11 @@ "spec": [ { "type": "text", - "text": "Adds cookies into this browser context. All pages within this context will have these cookies installed. Cookies can be obtained via [`method: BrowserContext.cookies`]." + "text": "Adds cookies into this browser context. All pages within this context will have these cookies installed. Cookies can be↵obtained via [`method: BrowserContext.cookies`]." + }, + { + "type": "text", + "text": "**Usage**" }, { "type": "code", @@ -19151,8 +20925,7 @@ } ], "required": true, - "comment": "Adds cookies into this browser context. All pages within this context will have these cookies installed. Cookies can be\nobtained via [`method: BrowserContext.cookies`].\n\n```js\nawait browserContext.addCookies([cookieObject1, cookieObject2]);\n```\n\n```java\nbrowserContext.addCookies(Arrays.asList(cookieObject1, cookieObject2));\n```\n\n```python async\nawait browser_context.add_cookies([cookie_object1, cookie_object2])\n```\n\n```python sync\nbrowser_context.add_cookies([cookie_object1, cookie_object2])\n```\n\n```csharp\nawait context.AddCookiesAsync(new[] { cookie1, cookie2 });\n```\n", - "deprecated": false, + "comment": "Adds cookies into this browser context. All pages within this context will have these cookies installed. Cookies\ncan be obtained via [`method: BrowserContext.cookies`].\n\n**Usage**\n\n```js\nawait browserContext.addCookies([cookieObject1, cookieObject2]);\n```\n\n```java\nbrowserContext.addCookies(Arrays.asList(cookieObject1, cookieObject2));\n```\n\n```py\nawait browser_context.add_cookies([cookie_object1, cookie_object2])\n```\n\n```py\nbrowser_context.add_cookies([cookie_object1, cookie_object2])\n```\n\n```csharp\nawait context.AddCookiesAsync(new[] { cookie1, cookie2 });\n```\n", "async": true, "alias": "addCookies", "overloadIndex": 0, @@ -19188,7 +20961,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "name", "overloadIndex": 0, @@ -19212,7 +20984,6 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "value", "overloadIndex": 0, @@ -19236,7 +21007,6 @@ ], "required": false, "comment": "either url or domain / path are required. Optional.", - "deprecated": false, "async": false, "alias": "url", "overloadIndex": 0, @@ -19260,7 +21030,6 @@ ], "required": false, "comment": "either url or domain / path are required Optional.", - "deprecated": false, "async": false, "alias": "domain", "overloadIndex": 0, @@ -19284,7 +21053,6 @@ ], "required": false, "comment": "either url or domain / path are required Optional.", - "deprecated": false, "async": false, "alias": "path", "overloadIndex": 0, @@ -19308,7 +21076,6 @@ ], "required": false, "comment": "Unix time in seconds. Optional.", - "deprecated": false, "async": false, "alias": "expires", "overloadIndex": 0, @@ -19332,7 +21099,6 @@ ], "required": false, "comment": "Optional.", - "deprecated": false, "async": false, "alias": "httpOnly", "overloadIndex": 0, @@ -19356,7 +21122,6 @@ ], "required": false, "comment": "Optional.", - "deprecated": false, "async": false, "alias": "secure", "overloadIndex": 0, @@ -19391,7 +21156,6 @@ ], "required": false, "comment": "Optional.", - "deprecated": false, "async": false, "alias": "sameSite", "overloadIndex": 0, @@ -19405,7 +21169,6 @@ "spec": [], "required": true, "comment": "", - "deprecated": false, "async": false, "alias": "cookies", "overloadIndex": 0, @@ -19434,12 +21197,16 @@ }, { "type": "li", - "text": "Whenever a child frame is attached or navigated in any page in the browser context. In this case, the script is evaluated in the context of the newly attached frame.", + "text": "Whenever a child frame is attached or navigated in any page in the browser context. In this case, the script is↵evaluated in the context of the newly attached frame.", "liType": "bullet" }, { "type": "text", - "text": "The script is evaluated after the document was created but before any of its scripts were run. This is useful to amend the JavaScript environment, e.g. to seed `Math.random`." + "text": "The script is evaluated after the document was created but before any of its scripts were run. This is useful to amend↵the JavaScript environment, e.g. to seed `Math.random`." + }, + { + "type": "text", + "text": "**Usage**" }, { "type": "text", @@ -19490,19 +21257,18 @@ { "type": "code", "lines": [ - "await context.AddInitScriptAsync(new BrowserContextAddInitScriptOptions { ScriptPath = \"preload.js\" });" + "await context.AddInitScriptAsync(scriptPath: \"preload.js\");" ], "codeLang": "csharp" }, { "type": "note", "noteType": "note", - "text": "The order of evaluation of multiple scripts installed via [`method: BrowserContext.addInitScript`] and [`method: Page.addInitScript`] is not defined." + "text": "The order of evaluation of multiple scripts installed via [`method: BrowserContext.addInitScript`] and↵[`method: Page.addInitScript`] is not defined." } ], "required": true, - "comment": "Adds a script which would be evaluated in one of the following scenarios:\n- Whenever a page is created in the browser context or is navigated.\n- Whenever a child frame is attached or navigated in any page in the browser context. In this case, the script is\n evaluated in the context of the newly attached frame.\n\nThe script is evaluated after the document was created but before any of its scripts were run. This is useful to amend\nthe JavaScript environment, e.g. to seed `Math.random`.\n\nAn example of overriding `Math.random` before the page loads:\n\n```js browser\n// preload.js\nMath.random = () => 42;\n```\n\n```js\n// In your playwright script, assuming the preload.js file is in same directory.\nawait browserContext.addInitScript({\n path: 'preload.js'\n});\n```\n\n```java\n// In your playwright script, assuming the preload.js file is in same directory.\nbrowserContext.addInitScript(Paths.get(\"preload.js\"));\n```\n\n```python async\n# in your playwright script, assuming the preload.js file is in same directory.\nawait browser_context.add_init_script(path=\"preload.js\")\n```\n\n```python sync\n# in your playwright script, assuming the preload.js file is in same directory.\nbrowser_context.add_init_script(path=\"preload.js\")\n```\n\n```csharp\nawait context.AddInitScriptAsync(new BrowserContextAddInitScriptOptions { ScriptPath = \"preload.js\" });\n```\n\n> NOTE: The order of evaluation of multiple scripts installed via [`method: BrowserContext.addInitScript`] and\n[`method: Page.addInitScript`] is not defined.", - "deprecated": false, + "comment": "Adds a script which would be evaluated in one of the following scenarios:\n- Whenever a page is created in the browser context or is navigated.\n- Whenever a child frame is attached or navigated in any page in the browser context. In this case, the script is\n evaluated in the context of the newly attached frame.\n\nThe script is evaluated after the document was created but before any of its scripts were run. This is useful to\namend the JavaScript environment, e.g. to seed `Math.random`.\n\n**Usage**\n\nAn example of overriding `Math.random` before the page loads:\n\n```js\n// preload.js\nMath.random = () => 42;\n```\n\n```js\n// In your playwright script, assuming the preload.js file is in same directory.\nawait browserContext.addInitScript({\n path: 'preload.js'\n});\n```\n\n```java\n// In your playwright script, assuming the preload.js file is in same directory.\nbrowserContext.addInitScript(Paths.get(\"preload.js\"));\n```\n\n```py\n# in your playwright script, assuming the preload.js file is in same directory.\nawait browser_context.add_init_script(path=\"preload.js\")\n```\n\n```py\n# in your playwright script, assuming the preload.js file is in same directory.\nbrowser_context.add_init_script(path=\"preload.js\")\n```\n\n```csharp\nawait context.AddInitScriptAsync(scriptPath: \"preload.js\");\n```\n\n**NOTE** The order of evaluation of multiple scripts installed via [`method: BrowserContext.addInitScript`] and\n[`method: Page.addInitScript`] is not defined.", "async": true, "alias": "addInitScript", "overloadIndex": 0, @@ -19546,12 +21312,11 @@ "spec": [ { "type": "text", - "text": "Path to the JavaScript file. If `path` is a relative path, then it is resolved relative to the current working directory. Optional." + "text": "Path to the JavaScript file. If `path` is a relative path, then it is resolved relative to the↵current working directory. Optional." } ], "required": false, "comment": "Path to the JavaScript file. If `path` is a relative path, then it is resolved relative to the current working\ndirectory. Optional.", - "deprecated": false, "async": false, "alias": "path", "overloadIndex": 0, @@ -19575,7 +21340,6 @@ ], "required": false, "comment": "Raw script content. Optional.", - "deprecated": false, "async": false, "alias": "content", "overloadIndex": 0, @@ -19594,7 +21358,6 @@ ], "required": true, "comment": "Script to be evaluated in all pages in the browser context.", - "deprecated": false, "async": false, "alias": "script", "overloadIndex": 0, @@ -19634,7 +21397,6 @@ ], "required": true, "comment": "Script to be evaluated in all pages in the browser context.", - "deprecated": false, "async": false, "alias": "script", "overloadIndex": 0, @@ -19665,7 +21427,6 @@ ], "required": false, "comment": "Optional argument to pass to `script` (only supported when passing a function).", - "deprecated": false, "async": false, "alias": "arg", "overloadIndex": 0, @@ -19696,7 +21457,6 @@ ], "required": false, "comment": "Path to the JavaScript file. If `path` is a relative path, then it is resolved relative to the current working\ndirectory. Optional.", - "deprecated": false, "async": false, "alias": "path", "overloadIndex": 0, @@ -19727,7 +21487,6 @@ ], "required": false, "comment": "Script to be evaluated in all pages in the browser context. Optional.", - "deprecated": false, "async": false, "alias": "script", "overloadIndex": 0, @@ -19770,8 +21529,7 @@ } ], "required": true, - "comment": "> NOTE: Background pages are only supported on Chromium-based browsers.\n\nAll existing background pages in the context.", - "deprecated": false, + "comment": "**NOTE** Background pages are only supported on Chromium-based browsers.\n\nAll existing background pages in the context.", "async": false, "alias": "backgroundPages", "overloadIndex": 0, @@ -19804,7 +21562,6 @@ ], "required": true, "comment": "Returns the browser instance of the context. If it was launched as a persistent context null gets returned.", - "deprecated": false, "async": false, "alias": "browser", "overloadIndex": 0, @@ -19828,7 +21585,6 @@ ], "required": true, "comment": "Clears context cookies.", - "deprecated": false, "async": true, "alias": "clearCookies", "overloadIndex": 0, @@ -19849,6 +21605,10 @@ "type": "text", "text": "Clears all permission overrides for the browser context." }, + { + "type": "text", + "text": "**Usage**" + }, { "type": "code", "lines": [ @@ -19903,8 +21663,7 @@ } ], "required": true, - "comment": "Clears all permission overrides for the browser context.\n\n```js\nconst context = await browser.newContext();\nawait context.grantPermissions(['clipboard-read']);\n// do stuff ..\ncontext.clearPermissions();\n```\n\n```java\nBrowserContext context = browser.newContext();\ncontext.grantPermissions(Arrays.asList(\"clipboard-read\"));\n// do stuff ..\ncontext.clearPermissions();\n```\n\n```python async\ncontext = await browser.new_context()\nawait context.grant_permissions([\"clipboard-read\"])\n# do stuff ..\ncontext.clear_permissions()\n```\n\n```python sync\ncontext = browser.new_context()\ncontext.grant_permissions([\"clipboard-read\"])\n# do stuff ..\ncontext.clear_permissions()\n```\n\n```csharp\nvar context = await browser.NewContextAsync();\nawait context.GrantPermissionsAsync(new[] { \"clipboard-read\" });\n// Alternatively, you can use the helper class ContextPermissions\n// to specify the permissions...\n// do stuff ...\nawait context.ClearPermissionsAsync();\n```\n", - "deprecated": false, + "comment": "Clears all permission overrides for the browser context.\n\n**Usage**\n\n```js\nconst context = await browser.newContext();\nawait context.grantPermissions(['clipboard-read']);\n// do stuff ..\ncontext.clearPermissions();\n```\n\n```java\nBrowserContext context = browser.newContext();\ncontext.grantPermissions(Arrays.asList(\"clipboard-read\"));\n// do stuff ..\ncontext.clearPermissions();\n```\n\n```py\ncontext = await browser.new_context()\nawait context.grant_permissions([\"clipboard-read\"])\n# do stuff ..\ncontext.clear_permissions()\n```\n\n```py\ncontext = browser.new_context()\ncontext.grant_permissions([\"clipboard-read\"])\n# do stuff ..\ncontext.clear_permissions()\n```\n\n```csharp\nvar context = await browser.NewContextAsync();\nawait context.GrantPermissionsAsync(new[] { \"clipboard-read\" });\n// Alternatively, you can use the helper class ContextPermissions\n// to specify the permissions...\n// do stuff ...\nawait context.ClearPermissionsAsync();\n```\n", "async": true, "alias": "clearPermissions", "overloadIndex": 0, @@ -19932,8 +21691,7 @@ } ], "required": true, - "comment": "Closes the browser context. All the pages that belong to the browser context will be closed.\n\n> NOTE: The default browser context cannot be closed.", - "deprecated": false, + "comment": "Closes the browser context. All the pages that belong to the browser context will be closed.\n\n**NOTE** The default browser context cannot be closed.", "async": true, "alias": "close", "overloadIndex": 0, @@ -19954,587 +21712,7444 @@ "properties": [ { "kind": "property", - "langs": {}, + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "name", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "name", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "value", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "value", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "domain", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "domain", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "path", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "path", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "expires", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Unix time in seconds." + } + ], + "required": true, + "comment": "Unix time in seconds.", + "async": false, + "alias": "expires", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "httpOnly", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "httpOnly", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "secure", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "secure", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "sameSite", + "type": { + "name": "SameSiteAttribute", + "union": [ + { + "name": "\"Strict\"" + }, + { + "name": "\"Lax\"" + }, + { + "name": "\"None\"" + } + ], + "expression": "[SameSiteAttribute]<\"Strict\"|\"Lax\"|\"None\">" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "sameSite", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ], + "expression": "[Array]<[Object]>" + }, + "spec": [ + { + "type": "text", + "text": "If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those URLs↵are returned." + } + ], + "required": true, + "comment": "If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those\nURLs are returned.", + "async": true, + "alias": "cookies", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "urls", + "type": { + "name": "", + "union": [ + { + "name": "string" + }, + { + "name": "Array", + "templates": [ + { + "name": "string" + } + ] + } + ], + "expression": "[string]|[Array]<[string]>" + }, + "spec": [ + { + "type": "text", + "text": "Optional list of URLs." + } + ], + "required": false, + "comment": "Optional list of URLs.", + "async": false, + "alias": "urls", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "exposeBinding", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "The method adds a function called `name` on the `window` object of every frame in every page in the context.↵When called, the function executes `callback` and returns a [Promise] which resolves to the return value of↵`callback`. If the `callback` returns a [Promise], it will be awaited." + }, + { + "type": "text", + "text": "The first argument of the `callback` function contains information about the caller: `{ browserContext:↵BrowserContext, page: Page, frame: Frame }`." + }, + { + "type": "text", + "text": "See [`method: Page.exposeBinding`] for page-only version." + }, + { + "type": "text", + "text": "**Usage**" + }, + { + "type": "text", + "text": "An example of exposing page URL to all frames in all pages in the context:" + }, + { + "type": "code", + "lines": [ + "const { webkit } = require('playwright'); // Or 'chromium' or 'firefox'.", + "", + "(async () => {", + " const browser = await webkit.launch({ headless: false });", + " const context = await browser.newContext();", + " await context.exposeBinding('pageURL', ({ page }) => page.url());", + " const page = await context.newPage();", + " await page.setContent(`", + " ", + " ", + "
", + " `);", + " await page.getByRole('button').click();", + "})();" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "import com.microsoft.playwright.*;", + "", + "public class Example {", + " public static void main(String[] args) {", + " try (Playwright playwright = Playwright.create()) {", + " BrowserType webkit = playwright.webkit()", + " Browser browser = webkit.launch(new BrowserType.LaunchOptions().setHeadless(false));", + " BrowserContext context = browser.newContext();", + " context.exposeBinding(\"pageURL\", (source, args) -> source.page().url());", + " Page page = context.newPage();", + " page.setContent(\"\\n\" +", + " \"\\n\" +", + " \"
\");", + " page.getByRole(AriaRole.BUTTON).click();", + " }", + " }", + "}" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "import asyncio", + "from playwright.async_api import async_playwright", + "", + "async def run(playwright):", + " webkit = playwright.webkit", + " browser = await webkit.launch(headless=false)", + " context = await browser.new_context()", + " await context.expose_binding(\"pageURL\", lambda source: source[\"page\"].url)", + " page = await context.new_page()", + " await page.set_content(\"\"\"", + " ", + " ", + "
", + " \"\"\")", + " await page.get_by_role(\"button\").click()", + "", + "async def main():", + " async with async_playwright() as playwright:", + " await run(playwright)", + "asyncio.run(main())" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "from playwright.sync_api import sync_playwright", + "", + "def run(playwright):", + " webkit = playwright.webkit", + " browser = webkit.launch(headless=false)", + " context = browser.new_context()", + " context.expose_binding(\"pageURL\", lambda source: source[\"page\"].url)", + " page = context.new_page()", + " page.set_content(\"\"\"", + " ", + " ", + "
", + " \"\"\")", + " page.get_by_role(\"button\").click()", + "", + "with sync_playwright() as playwright:", + " run(playwright)" + ], + "codeLang": "python sync" + }, + { + "type": "code", + "lines": [ + "using Microsoft.Playwright;", + "", + "using var playwright = await Playwright.CreateAsync();", + "var browser = await playwright.Webkit.LaunchAsync(new() { Headless = false });", + "var context = await browser.NewContextAsync();", + "", + "await context.ExposeBindingAsync(\"pageURL\", source => source.Page.Url);", + "var page = await context.NewPageAsync();", + "await page.SetContentAsync(\"\\n\" +", + "\"\\n\" +", + "\"
\");", + "await page.GetByRole(AriaRole.Button).ClickAsync();" + ], + "codeLang": "csharp" + }, + { + "type": "text", + "text": "An example of passing an element handle:" + }, + { + "type": "code", + "lines": [ + "await context.exposeBinding('clicked', async (source, element) => {", + " console.log(await element.textContent());", + "}, { handle: true });", + "await page.setContent(`", + " ", + "
Click me
", + "
Or click me
", + "`);" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "context.exposeBinding(\"clicked\", (source, args) -> {", + " ElementHandle element = (ElementHandle) args[0];", + " System.out.println(element.textContent());", + " return null;", + "}, new BrowserContext.ExposeBindingOptions().setHandle(true));", + "page.setContent(\"\" +", + " \"\\n\" +", + " \"
Click me
\\n\" +", + " \"
Or click me
\\n\");" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "async def print(source, element):", + " print(await element.text_content())", + "", + "await context.expose_binding(\"clicked\", print, handle=true)", + "await page.set_content(\"\"\"", + " ", + "
Click me
", + "
Or click me
", + "\"\"\")" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "def print(source, element):", + " print(element.text_content())", + "", + "context.expose_binding(\"clicked\", print, handle=true)", + "page.set_content(\"\"\"", + " ", + "
Click me
", + "
Or click me
", + "\"\"\")" + ], + "codeLang": "python sync" + }, + { + "type": "code", + "lines": [ + "var result = new TaskCompletionSource();", + "var page = await Context.NewPageAsync();", + "await Context.ExposeBindingAsync(\"clicked\", async (BindingSource _, IJSHandle t) =>", + "{", + " return result.TrySetResult(await t.AsElement().TextContentAsync());", + "});", + "", + "await page.SetContentAsync(\"\\n\" +", + " \"
Click me
\\n\" +", + " \"
Or click me
\\n\");", + "", + "await page.ClickAsync(\"div\");", + "// Note: it makes sense to await the result here, because otherwise, the context", + "// gets closed and the binding function will throw an exception.", + "Assert.AreEqual(\"Click me\", await result.Task);" + ], + "codeLang": "csharp" + } + ], + "required": true, + "comment": "The method adds a function called `name` on the `window` object of every frame in every page in the context. When\ncalled, the function executes `callback` and returns a [Promise] which resolves to the return value of `callback`.\nIf the `callback` returns a [Promise], it will be awaited.\n\nThe first argument of the `callback` function contains information about the caller: `{ browserContext:\nBrowserContext, page: Page, frame: Frame }`.\n\nSee [`method: Page.exposeBinding`] for page-only version.\n\n**Usage**\n\nAn example of exposing page URL to all frames in all pages in the context:\n\n```js\nconst { webkit } = require('playwright'); // Or 'chromium' or 'firefox'.\n\n(async () => {\n const browser = await webkit.launch({ headless: false });\n const context = await browser.newContext();\n await context.exposeBinding('pageURL', ({ page }) => page.url());\n const page = await context.newPage();\n await page.setContent(`\n \n \n
\n `);\n await page.getByRole('button').click();\n})();\n```\n\n```java\nimport com.microsoft.playwright.*;\n\npublic class Example {\n public static void main(String[] args) {\n try (Playwright playwright = Playwright.create()) {\n BrowserType webkit = playwright.webkit()\n Browser browser = webkit.launch(new BrowserType.LaunchOptions().setHeadless(false));\n BrowserContext context = browser.newContext();\n context.exposeBinding(\"pageURL\", (source, args) -> source.page().url());\n Page page = context.newPage();\n page.setContent(\"\\n\" +\n \"\\n\" +\n \"
\");\n page.getByRole(AriaRole.BUTTON).click();\n }\n }\n}\n```\n\n```py\nimport asyncio\nfrom playwright.async_api import async_playwright\n\nasync def run(playwright):\n webkit = playwright.webkit\n browser = await webkit.launch(headless=false)\n context = await browser.new_context()\n await context.expose_binding(\"pageURL\", lambda source: source[\"page\"].url)\n page = await context.new_page()\n await page.set_content(\"\"\"\n \n \n
\n \"\"\")\n await page.get_by_role(\"button\").click()\n\nasync def main():\n async with async_playwright() as playwright:\n await run(playwright)\nasyncio.run(main())\n```\n\n```py\nfrom playwright.sync_api import sync_playwright\n\ndef run(playwright):\n webkit = playwright.webkit\n browser = webkit.launch(headless=false)\n context = browser.new_context()\n context.expose_binding(\"pageURL\", lambda source: source[\"page\"].url)\n page = context.new_page()\n page.set_content(\"\"\"\n \n \n
\n \"\"\")\n page.get_by_role(\"button\").click()\n\nwith sync_playwright() as playwright:\n run(playwright)\n```\n\n```csharp\nusing Microsoft.Playwright;\n\nusing var playwright = await Playwright.CreateAsync();\nvar browser = await playwright.Webkit.LaunchAsync(new() { Headless = false });\nvar context = await browser.NewContextAsync();\n\nawait context.ExposeBindingAsync(\"pageURL\", source => source.Page.Url);\nvar page = await context.NewPageAsync();\nawait page.SetContentAsync(\"\\n\" +\n\"\\n\" +\n\"
\");\nawait page.GetByRole(AriaRole.Button).ClickAsync();\n```\n\nAn example of passing an element handle:\n\n```js\nawait context.exposeBinding('clicked', async (source, element) => {\n console.log(await element.textContent());\n}, { handle: true });\nawait page.setContent(`\n \n
Click me
\n
Or click me
\n`);\n```\n\n```java\ncontext.exposeBinding(\"clicked\", (source, args) -> {\n ElementHandle element = (ElementHandle) args[0];\n System.out.println(element.textContent());\n return null;\n}, new BrowserContext.ExposeBindingOptions().setHandle(true));\npage.setContent(\"\" +\n \"\\n\" +\n \"
Click me
\\n\" +\n \"
Or click me
\\n\");\n```\n\n```py\nasync def print(source, element):\n print(await element.text_content())\n\nawait context.expose_binding(\"clicked\", print, handle=true)\nawait page.set_content(\"\"\"\n \n
Click me
\n
Or click me
\n\"\"\")\n```\n\n```py\ndef print(source, element):\n print(element.text_content())\n\ncontext.expose_binding(\"clicked\", print, handle=true)\npage.set_content(\"\"\"\n \n
Click me
\n
Or click me
\n\"\"\")\n```\n\n```csharp\nvar result = new TaskCompletionSource();\nvar page = await Context.NewPageAsync();\nawait Context.ExposeBindingAsync(\"clicked\", async (BindingSource _, IJSHandle t) =>\n{\n return result.TrySetResult(await t.AsElement().TextContentAsync());\n});\n\nawait page.SetContentAsync(\"\\n\" +\n \"
Click me
\\n\" +\n \"
Or click me
\\n\");\n\nawait page.ClickAsync(\"div\");\n// Note: it makes sense to await the result here, because otherwise, the context\n// gets closed and the binding function will throw an exception.\nAssert.AreEqual(\"Click me\", await result.Task);\n```\n", + "async": true, + "alias": "exposeBinding", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "name", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Name of the function on the window object." + } + ], + "required": true, + "comment": "Name of the function on the window object.", + "async": false, + "alias": "name", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "callback", + "type": { + "name": "function", + "expression": "[function]" + }, + "spec": [ + { + "type": "text", + "text": "Callback function that will be called in the Playwright's context." + } + ], + "required": true, + "comment": "Callback function that will be called in the Playwright's context.", + "async": false, + "alias": "callback", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "options", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "handle", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Whether to pass the argument as a handle, instead of passing by value. When passing a handle, only one argument is↵supported. When passing by value, multiple arguments are supported." + } + ], + "required": false, + "comment": "Whether to pass the argument as a handle, instead of passing by value. When passing a handle, only one argument is\nsupported. When passing by value, multiple arguments are supported.", + "async": false, + "alias": "handle", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + "required": false, + "comment": "", + "async": false, + "alias": "options", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "exposeFunction", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "The method adds a function called `name` on the `window` object of every frame in every page in the context.↵When called, the function executes `callback` and returns a [Promise] which resolves to the return value of↵`callback`." + }, + { + "type": "text", + "text": "If the `callback` returns a [Promise], it will be awaited." + }, + { + "type": "text", + "text": "See [`method: Page.exposeFunction`] for page-only version." + }, + { + "type": "text", + "text": "**Usage**" + }, + { + "type": "text", + "text": "An example of adding a `sha256` function to all pages in the context:" + }, + { + "type": "code", + "lines": [ + "const { webkit } = require('playwright'); // Or 'chromium' or 'firefox'.", + "const crypto = require('crypto');", + "", + "(async () => {", + " const browser = await webkit.launch({ headless: false });", + " const context = await browser.newContext();", + " await context.exposeFunction('sha256', text => crypto.createHash('sha256').update(text).digest('hex'));", + " const page = await context.newPage();", + " await page.setContent(`", + " ", + " ", + "
", + " `);", + " await page.getByRole('button').click();", + "})();" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "import com.microsoft.playwright.*;", + "", + "import java.nio.charset.StandardCharsets;", + "import java.security.MessageDigest;", + "import java.security.NoSuchAlgorithmException;", + "import java.util.Base64;", + "", + "public class Example {", + " public static void main(String[] args) {", + " try (Playwright playwright = Playwright.create()) {", + " BrowserType webkit = playwright.webkit()", + " Browser browser = webkit.launch(new BrowserType.LaunchOptions().setHeadless(false));", + " context.exposeFunction(\"sha256\", args -> {", + " String text = (String) args[0];", + " MessageDigest crypto;", + " try {", + " crypto = MessageDigest.getInstance(\"SHA-256\");", + " } catch (NoSuchAlgorithmException e) {", + " return null;", + " }", + " byte[] token = crypto.digest(text.getBytes(StandardCharsets.UTF_8));", + " return Base64.getEncoder().encodeToString(token);", + " });", + " Page page = context.newPage();", + " page.setContent(\"\\n\" +", + " \"\\n\" +", + " \"
\\n\");", + " page.getByRole(AriaRole.BUTTON).click();", + " }", + " }", + "}" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "import asyncio", + "import hashlib", + "from playwright.async_api import async_playwright", + "", + "def sha256(text):", + " m = hashlib.sha256()", + " m.update(bytes(text, \"utf8\"))", + " return m.hexdigest()", + "", + "", + "async def run(playwright):", + " webkit = playwright.webkit", + " browser = await webkit.launch(headless=False)", + " context = await browser.new_context()", + " await context.expose_function(\"sha256\", sha256)", + " page = await context.new_page()", + " await page.set_content(\"\"\"", + " ", + " ", + "
", + " \"\"\")", + " await page.get_by_role(\"button\").click()", + "", + "async def main():", + " async with async_playwright() as playwright:", + " await run(playwright)", + "asyncio.run(main())" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "import hashlib", + "from playwright.sync_api import sync_playwright", + "", + "def sha256(text):", + " m = hashlib.sha256()", + " m.update(bytes(text, \"utf8\"))", + " return m.hexdigest()", + "", + "", + "def run(playwright):", + " webkit = playwright.webkit", + " browser = webkit.launch(headless=False)", + " context = browser.new_context()", + " context.expose_function(\"sha256\", sha256)", + " page = context.new_page()", + " page.set_content(\"\"\"", + " ", + " ", + "
", + " \"\"\")", + " page.get_by_role(\"button\").click()", + "", + "with sync_playwright() as playwright:", + " run(playwright)" + ], + "codeLang": "python sync" + }, + { + "type": "code", + "lines": [ + "using Microsoft.Playwright;", + "using System;", + "using System.Security.Cryptography;", + "using System.Threading.Tasks;", + "", + "class BrowserContextExamples", + "{", + " public static async Task Main()", + " {", + " using var playwright = await Playwright.CreateAsync();", + " var browser = await playwright.Webkit.LaunchAsync(new() { Headless = false });", + " var context = await browser.NewContextAsync();", + "", + " await context.ExposeFunctionAsync(\"sha256\", (string input) =>", + " {", + " return Convert.ToBase64String(", + " SHA256.Create().ComputeHash(System.Text.Encoding.UTF8.GetBytes(input)));", + " });", + "", + " var page = await context.NewPageAsync();", + " await page.SetContentAsync(\"\\n\" +", + " \"\\n\" +", + " \"
\");", + "", + " await page.GetByRole(AriaRole.Button).ClickAsync();", + " Console.WriteLine(await page.TextContentAsync(\"div\"));", + " }", + "}" + ], + "codeLang": "csharp" + } + ], + "required": true, + "comment": "The method adds a function called `name` on the `window` object of every frame in every page in the context. When\ncalled, the function executes `callback` and returns a [Promise] which resolves to the return value of `callback`.\n\nIf the `callback` returns a [Promise], it will be awaited.\n\nSee [`method: Page.exposeFunction`] for page-only version.\n\n**Usage**\n\nAn example of adding a `sha256` function to all pages in the context:\n\n```js\nconst { webkit } = require('playwright'); // Or 'chromium' or 'firefox'.\nconst crypto = require('crypto');\n\n(async () => {\n const browser = await webkit.launch({ headless: false });\n const context = await browser.newContext();\n await context.exposeFunction('sha256', text => crypto.createHash('sha256').update(text).digest('hex'));\n const page = await context.newPage();\n await page.setContent(`\n \n \n
\n `);\n await page.getByRole('button').click();\n})();\n```\n\n```java\nimport com.microsoft.playwright.*;\n\nimport java.nio.charset.StandardCharsets;\nimport java.security.MessageDigest;\nimport java.security.NoSuchAlgorithmException;\nimport java.util.Base64;\n\npublic class Example {\n public static void main(String[] args) {\n try (Playwright playwright = Playwright.create()) {\n BrowserType webkit = playwright.webkit()\n Browser browser = webkit.launch(new BrowserType.LaunchOptions().setHeadless(false));\n context.exposeFunction(\"sha256\", args -> {\n String text = (String) args[0];\n MessageDigest crypto;\n try {\n crypto = MessageDigest.getInstance(\"SHA-256\");\n } catch (NoSuchAlgorithmException e) {\n return null;\n }\n byte[] token = crypto.digest(text.getBytes(StandardCharsets.UTF_8));\n return Base64.getEncoder().encodeToString(token);\n });\n Page page = context.newPage();\n page.setContent(\"\\n\" +\n \"\\n\" +\n \"
\\n\");\n page.getByRole(AriaRole.BUTTON).click();\n }\n }\n}\n```\n\n```py\nimport asyncio\nimport hashlib\nfrom playwright.async_api import async_playwright\n\ndef sha256(text):\n m = hashlib.sha256()\n m.update(bytes(text, \"utf8\"))\n return m.hexdigest()\n\n\nasync def run(playwright):\n webkit = playwright.webkit\n browser = await webkit.launch(headless=False)\n context = await browser.new_context()\n await context.expose_function(\"sha256\", sha256)\n page = await context.new_page()\n await page.set_content(\"\"\"\n \n \n
\n \"\"\")\n await page.get_by_role(\"button\").click()\n\nasync def main():\n async with async_playwright() as playwright:\n await run(playwright)\nasyncio.run(main())\n```\n\n```py\nimport hashlib\nfrom playwright.sync_api import sync_playwright\n\ndef sha256(text):\n m = hashlib.sha256()\n m.update(bytes(text, \"utf8\"))\n return m.hexdigest()\n\n\ndef run(playwright):\n webkit = playwright.webkit\n browser = webkit.launch(headless=False)\n context = browser.new_context()\n context.expose_function(\"sha256\", sha256)\n page = context.new_page()\n page.set_content(\"\"\"\n \n \n
\n \"\"\")\n page.get_by_role(\"button\").click()\n\nwith sync_playwright() as playwright:\n run(playwright)\n```\n\n```csharp\nusing Microsoft.Playwright;\nusing System;\nusing System.Security.Cryptography;\nusing System.Threading.Tasks;\n\nclass BrowserContextExamples\n{\n public static async Task Main()\n {\n using var playwright = await Playwright.CreateAsync();\n var browser = await playwright.Webkit.LaunchAsync(new() { Headless = false });\n var context = await browser.NewContextAsync();\n\n await context.ExposeFunctionAsync(\"sha256\", (string input) =>\n {\n return Convert.ToBase64String(\n SHA256.Create().ComputeHash(System.Text.Encoding.UTF8.GetBytes(input)));\n });\n\n var page = await context.NewPageAsync();\n await page.SetContentAsync(\"\\n\" +\n \"\\n\" +\n \"
\");\n\n await page.GetByRole(AriaRole.Button).ClickAsync();\n Console.WriteLine(await page.TextContentAsync(\"div\"));\n }\n}\n```\n", + "async": true, + "alias": "exposeFunction", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "name", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Name of the function on the window object." + } + ], + "required": true, + "comment": "Name of the function on the window object.", + "async": false, + "alias": "name", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "callback", + "type": { + "name": "function", + "expression": "[function]" + }, + "spec": [ + { + "type": "text", + "text": "Callback function that will be called in the Playwright's context." + } + ], + "required": true, + "comment": "Callback function that will be called in the Playwright's context.", + "async": false, + "alias": "callback", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "grantPermissions", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "Grants specified permissions to the browser context. Only grants corresponding permissions to the given origin if↵specified." + } + ], + "required": true, + "comment": "Grants specified permissions to the browser context. Only grants corresponding permissions to the given origin if\nspecified.", + "async": true, + "alias": "grantPermissions", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "permissions", + "type": { + "name": "Array", + "templates": [ + { + "name": "string" + } + ], + "expression": "[Array]<[string]>" + }, + "spec": [ + { + "type": "text", + "text": "A permission or an array of permissions to grant. Permissions can be one of the following values:" + }, + { + "type": "li", + "text": "`'geolocation'`", + "liType": "bullet" + }, + { + "type": "li", + "text": "`'midi'`", + "liType": "bullet" + }, + { + "type": "li", + "text": "`'midi-sysex'` (system-exclusive midi)", + "liType": "bullet" + }, + { + "type": "li", + "text": "`'notifications'`", + "liType": "bullet" + }, + { + "type": "li", + "text": "`'camera'`", + "liType": "bullet" + }, + { + "type": "li", + "text": "`'microphone'`", + "liType": "bullet" + }, + { + "type": "li", + "text": "`'background-sync'`", + "liType": "bullet" + }, + { + "type": "li", + "text": "`'ambient-light-sensor'`", + "liType": "bullet" + }, + { + "type": "li", + "text": "`'accelerometer'`", + "liType": "bullet" + }, + { + "type": "li", + "text": "`'gyroscope'`", + "liType": "bullet" + }, + { + "type": "li", + "text": "`'magnetometer'`", + "liType": "bullet" + }, + { + "type": "li", + "text": "`'accessibility-events'`", + "liType": "bullet" + }, + { + "type": "li", + "text": "`'clipboard-read'`", + "liType": "bullet" + }, + { + "type": "li", + "text": "`'clipboard-write'`", + "liType": "bullet" + }, + { + "type": "li", + "text": "`'payment-handler'`", + "liType": "bullet" + } + ], + "required": true, + "comment": "A permission or an array of permissions to grant. Permissions can be one of the following values:\n- `'geolocation'`\n- `'midi'`\n- `'midi-sysex'` (system-exclusive midi)\n- `'notifications'`\n- `'camera'`\n- `'microphone'`\n- `'background-sync'`\n- `'ambient-light-sensor'`\n- `'accelerometer'`\n- `'gyroscope'`\n- `'magnetometer'`\n- `'accessibility-events'`\n- `'clipboard-read'`\n- `'clipboard-write'`\n- `'payment-handler'`", + "async": false, + "alias": "permissions", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "options", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "origin", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "The [origin] to grant permissions to, e.g. \"https://example.com\"." + } + ], + "required": false, + "comment": "The [origin] to grant permissions to, e.g. \"https://example.com\".", + "async": false, + "alias": "origin", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + "required": false, + "comment": "", + "async": false, + "alias": "options", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": { + "only": [ + "js", + "python", + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.11", + "name": "newCDPSession", + "type": { + "name": "CDPSession", + "expression": "[CDPSession]" + }, + "spec": [ + { + "type": "note", + "noteType": "note", + "text": "CDP sessions are only supported on Chromium-based browsers." + }, + { + "type": "text", + "text": "Returns the newly created session." + } + ], + "required": true, + "comment": "**NOTE** CDP sessions are only supported on Chromium-based browsers.\n\nReturns the newly created session.", + "async": true, + "alias": "newCDPSession", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.11", + "name": "page", + "type": { + "name": "", + "union": [ + { + "name": "Page" + }, + { + "name": "Frame" + } + ], + "expression": "[Page]|[Frame]" + }, + "spec": [ + { + "type": "text", + "text": "Target to create new session for. For backwards-compatibility, this parameter is↵named `page`, but it can be a `Page` or `Frame` type." + } + ], + "required": true, + "comment": "Target to create new session for. For backwards-compatibility, this parameter is named `page`, but it can be a\n`Page` or `Frame` type.", + "async": false, + "alias": "page", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "newPage", + "type": { + "name": "Page", + "expression": "[Page]" + }, + "spec": [ + { + "type": "text", + "text": "Creates a new page in the browser context." + } + ], + "required": true, + "comment": "Creates a new page in the browser context.", + "async": true, + "alias": "newPage", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "pages", + "type": { + "name": "Array", + "templates": [ + { + "name": "Page" + } + ], + "expression": "[Array]<[Page]>" + }, + "spec": [ + { + "type": "text", + "text": "Returns all open pages in the context." + } + ], + "required": true, + "comment": "Returns all open pages in the context.", + "async": false, + "alias": "pages", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "property", + "langs": { + "aliases": { + "csharp": "APIRequest" + }, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.16", + "name": "request", + "type": { + "name": "APIRequestContext", + "expression": "[APIRequestContext]" + }, + "spec": [ + { + "type": "text", + "text": "API testing helper associated with this context. Requests made with this API will use context cookies." + } + ], + "required": true, + "comment": "API testing helper associated with this context. Requests made with this API will use context cookies.", + "async": false, + "alias": "request", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "route", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "Routing provides the capability to modify network requests that are made by any page in the browser context. Once route↵is enabled, every request matching the url pattern will stall unless it's continued, fulfilled or aborted." + }, + { + "type": "note", + "noteType": "note", + "text": "[`method: BrowserContext.route`] will not intercept requests intercepted by Service Worker. See [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using request interception by setting `Browser.newContext.serviceWorkers` to `'block'`." + }, + { + "type": "text", + "text": "**Usage**" + }, + { + "type": "text", + "text": "An example of a naive handler that aborts all image requests:" + }, + { + "type": "code", + "lines": [ + "const context = await browser.newContext();", + "await context.route('**/*.{png,jpg,jpeg}', route => route.abort());", + "const page = await context.newPage();", + "await page.goto('https://example.com');", + "await browser.close();" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "BrowserContext context = browser.newContext();", + "context.route(\"**/*.{png,jpg,jpeg}\", route -> route.abort());", + "Page page = context.newPage();", + "page.navigate(\"https://example.com\");", + "browser.close();" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "context = await browser.new_context()", + "page = await context.new_page()", + "await context.route(\"**/*.{png,jpg,jpeg}\", lambda route: route.abort())", + "await page.goto(\"https://example.com\")", + "await browser.close()" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "context = browser.new_context()", + "page = context.new_page()", + "context.route(\"**/*.{png,jpg,jpeg}\", lambda route: route.abort())", + "page.goto(\"https://example.com\")", + "browser.close()" + ], + "codeLang": "python sync" + }, + { + "type": "code", + "lines": [ + "var context = await browser.NewContextAsync();", + "var page = await context.NewPageAsync();", + "await context.RouteAsync(\"**/*.{png,jpg,jpeg}\", r => r.AbortAsync());", + "await page.GotoAsync(\"https://theverge.com\");", + "await browser.CloseAsync();" + ], + "codeLang": "csharp" + }, + { + "type": "text", + "text": "or the same snippet using a regex pattern instead:" + }, + { + "type": "code", + "lines": [ + "const context = await browser.newContext();", + "await context.route(/(\\.png$)|(\\.jpg$)/, route => route.abort());", + "const page = await context.newPage();", + "await page.goto('https://example.com');", + "await browser.close();" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "BrowserContext context = browser.newContext();", + "context.route(Pattern.compile(\"(\\\\.png$)|(\\\\.jpg$)\"), route -> route.abort());", + "Page page = context.newPage();", + "page.navigate(\"https://example.com\");", + "browser.close();" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "context = await browser.new_context()", + "page = await context.new_page()", + "await context.route(re.compile(r\"(\\.png$)|(\\.jpg$)\"), lambda route: route.abort())", + "page = await context.new_page()", + "await page.goto(\"https://example.com\")", + "await browser.close()" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "context = browser.new_context()", + "page = context.new_page()", + "context.route(re.compile(r\"(\\.png$)|(\\.jpg$)\"), lambda route: route.abort())", + "page = await context.new_page()", + "page = context.new_page()", + "page.goto(\"https://example.com\")", + "browser.close()" + ], + "codeLang": "python sync" + }, + { + "type": "code", + "lines": [ + "var context = await browser.NewContextAsync();", + "var page = await context.NewPageAsync();", + "await context.RouteAsync(new Regex(\"(\\\\.png$)|(\\\\.jpg$)\"), r => r.AbortAsync());", + "await page.GotoAsync(\"https://theverge.com\");", + "await browser.CloseAsync();" + ], + "codeLang": "csharp" + }, + { + "type": "text", + "text": "It is possible to examine the request to decide the route action. For example, mocking all requests that contain some post data, and leaving all other requests as is:" + }, + { + "type": "code", + "lines": [ + "await context.route('/api/**', route => {", + " if (route.request().postData().includes('my-string'))", + " route.fulfill({ body: 'mocked-data' });", + " else", + " route.continue();", + "});" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "context.route(\"/api/**\", route -> {", + " if (route.request().postData().contains(\"my-string\"))", + " route.fulfill(new Route.FulfillOptions().setBody(\"mocked-data\"));", + " else", + " route.resume();", + "});" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "def handle_route(route):", + " if (\"my-string\" in route.request.post_data)", + " route.fulfill(body=\"mocked-data\")", + " else", + " route.continue_()", + "await context.route(\"/api/**\", handle_route)" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "def handle_route(route):", + " if (\"my-string\" in route.request.post_data)", + " route.fulfill(body=\"mocked-data\")", + " else", + " route.continue_()", + "context.route(\"/api/**\", handle_route)" + ], + "codeLang": "python sync" + }, + { + "type": "code", + "lines": [ + "await page.RouteAsync(\"/api/**\", async r =>", + "{", + " if (r.Request.PostData.Contains(\"my-string\"))", + " await r.FulfillAsync(body: \"mocked-data\");", + " else", + " await r.ContinueAsync();", + "});" + ], + "codeLang": "csharp" + }, + { + "type": "text", + "text": "Page routes (set up with [`method: Page.route`]) take precedence over browser context routes when request matches both↵handlers." + }, + { + "type": "text", + "text": "To remove a route with its handler you can use [`method: BrowserContext.unroute`]." + }, + { + "type": "note", + "noteType": "note", + "text": "Enabling routing disables http cache." + } + ], + "required": true, + "comment": "Routing provides the capability to modify network requests that are made by any page in the browser context. Once\nroute is enabled, every request matching the url pattern will stall unless it's continued, fulfilled or aborted.\n\n**NOTE** [`method: BrowserContext.route`] will not intercept requests intercepted by Service Worker. See\n[this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when\nusing request interception by setting `Browser.newContext.serviceWorkers` to `'block'`.\n\n**Usage**\n\nAn example of a naive handler that aborts all image requests:\n\n```js\nconst context = await browser.newContext();\nawait context.route('**/*.{png,jpg,jpeg}', route => route.abort());\nconst page = await context.newPage();\nawait page.goto('https://example.com');\nawait browser.close();\n```\n\n```java\nBrowserContext context = browser.newContext();\ncontext.route(\"**/*.{png,jpg,jpeg}\", route -> route.abort());\nPage page = context.newPage();\npage.navigate(\"https://example.com\");\nbrowser.close();\n```\n\n```py\ncontext = await browser.new_context()\npage = await context.new_page()\nawait context.route(\"**/*.{png,jpg,jpeg}\", lambda route: route.abort())\nawait page.goto(\"https://example.com\")\nawait browser.close()\n```\n\n```py\ncontext = browser.new_context()\npage = context.new_page()\ncontext.route(\"**/*.{png,jpg,jpeg}\", lambda route: route.abort())\npage.goto(\"https://example.com\")\nbrowser.close()\n```\n\n```csharp\nvar context = await browser.NewContextAsync();\nvar page = await context.NewPageAsync();\nawait context.RouteAsync(\"**/*.{png,jpg,jpeg}\", r => r.AbortAsync());\nawait page.GotoAsync(\"https://theverge.com\");\nawait browser.CloseAsync();\n```\n\nor the same snippet using a regex pattern instead:\n\n```js\nconst context = await browser.newContext();\nawait context.route(/(\\.png$)|(\\.jpg$)/, route => route.abort());\nconst page = await context.newPage();\nawait page.goto('https://example.com');\nawait browser.close();\n```\n\n```java\nBrowserContext context = browser.newContext();\ncontext.route(Pattern.compile(\"(\\\\.png$)|(\\\\.jpg$)\"), route -> route.abort());\nPage page = context.newPage();\npage.navigate(\"https://example.com\");\nbrowser.close();\n```\n\n```py\ncontext = await browser.new_context()\npage = await context.new_page()\nawait context.route(re.compile(r\"(\\.png$)|(\\.jpg$)\"), lambda route: route.abort())\npage = await context.new_page()\nawait page.goto(\"https://example.com\")\nawait browser.close()\n```\n\n```py\ncontext = browser.new_context()\npage = context.new_page()\ncontext.route(re.compile(r\"(\\.png$)|(\\.jpg$)\"), lambda route: route.abort())\npage = await context.new_page()\npage = context.new_page()\npage.goto(\"https://example.com\")\nbrowser.close()\n```\n\n```csharp\nvar context = await browser.NewContextAsync();\nvar page = await context.NewPageAsync();\nawait context.RouteAsync(new Regex(\"(\\\\.png$)|(\\\\.jpg$)\"), r => r.AbortAsync());\nawait page.GotoAsync(\"https://theverge.com\");\nawait browser.CloseAsync();\n```\n\nIt is possible to examine the request to decide the route action. For example, mocking all requests that contain\nsome post data, and leaving all other requests as is:\n\n```js\nawait context.route('/api/**', route => {\n if (route.request().postData().includes('my-string'))\n route.fulfill({ body: 'mocked-data' });\n else\n route.continue();\n});\n```\n\n```java\ncontext.route(\"/api/**\", route -> {\n if (route.request().postData().contains(\"my-string\"))\n route.fulfill(new Route.FulfillOptions().setBody(\"mocked-data\"));\n else\n route.resume();\n});\n```\n\n```py\ndef handle_route(route):\n if (\"my-string\" in route.request.post_data)\n route.fulfill(body=\"mocked-data\")\n else\n route.continue_()\nawait context.route(\"/api/**\", handle_route)\n```\n\n```py\ndef handle_route(route):\n if (\"my-string\" in route.request.post_data)\n route.fulfill(body=\"mocked-data\")\n else\n route.continue_()\ncontext.route(\"/api/**\", handle_route)\n```\n\n```csharp\nawait page.RouteAsync(\"/api/**\", async r =>\n{\n if (r.Request.PostData.Contains(\"my-string\"))\n await r.FulfillAsync(body: \"mocked-data\");\n else\n await r.ContinueAsync();\n});\n```\n\nPage routes (set up with [`method: Page.route`]) take precedence over browser context routes when request matches\nboth handlers.\n\nTo remove a route with its handler you can use [`method: BrowserContext.unroute`].\n\n**NOTE** Enabling routing disables http cache.", + "async": true, + "alias": "route", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "url", + "type": { + "name": "", + "union": [ + { + "name": "string" + }, + { + "name": "RegExp" + }, + { + "name": "function", + "args": [ + { + "name": "URL" + } + ], + "returnType": { + "name": "boolean" + } + } + ], + "expression": "[string]|[RegExp]|[function]([URL]):[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "A glob pattern, regex pattern or predicate receiving [URL] to match while routing.↵When a `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." + } + ], + "required": true, + "comment": "A glob pattern, regex pattern or predicate receiving [URL] to match while routing. When a `baseURL` via the context\noptions was provided and the passed URL is a path, it gets merged via the\n[`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor.", + "async": false, + "alias": "url", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "handler", + "type": { + "name": "function", + "args": [ + { + "name": "Route" + }, + { + "name": "Request" + } + ], + "returnType": { + "name": "", + "union": [ + { + "name": "Promise", + "templates": [ + { + "name": "any" + } + ] + }, + { + "name": "any" + } + ] + }, + "expression": "[function]([Route], [Request]): [Promise|any]" + }, + "spec": [ + { + "type": "text", + "text": "handler function to route the request." + } + ], + "required": true, + "comment": "handler function to route the request.", + "async": false, + "alias": "handler", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "handler", + "type": { + "name": "function", + "args": [ + { + "name": "Route" + } + ], + "expression": "[function]([Route])" + }, + "spec": [ + { + "type": "text", + "text": "handler function to route the request." + } + ], + "required": true, + "comment": "handler function to route the request.", + "async": false, + "alias": "handler", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "options", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.15", + "name": "times", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "How often a route should be used. By default it will be used every time." + } + ], + "required": false, + "comment": "How often a route should be used. By default it will be used every time.", + "async": false, + "alias": "times", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + "required": false, + "comment": "", + "async": false, + "alias": "options", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.23", + "name": "routeFromHAR", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "If specified the network requests that are made in the context will be served from the HAR file. Read more about [Replaying from HAR](../network.md#replaying-from-har)." + }, + { + "type": "text", + "text": "Playwright will not serve requests intercepted by Service Worker from the HAR file. See [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using request interception by setting `Browser.newContext.serviceWorkers` to `'block'`." + } + ], + "required": true, + "comment": "If specified the network requests that are made in the context will be served from the HAR file. Read more about\n[Replaying from HAR](../network.md#replaying-from-har).\n\nPlaywright will not serve requests intercepted by Service Worker from the HAR file. See\n[this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when\nusing request interception by setting `Browser.newContext.serviceWorkers` to `'block'`.", + "async": true, + "alias": "routeFromHAR", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.23", + "name": "har", + "type": { + "name": "path", + "expression": "[path]" + }, + "spec": [ + { + "type": "text", + "text": "Path to a [HAR](http://www.softwareishard.com/blog/har-12-spec) file with prerecorded network data. If `path` is a relative path, then it is resolved relative to the current working directory." + } + ], + "required": true, + "comment": "Path to a [HAR](http://www.softwareishard.com/blog/har-12-spec) file with prerecorded network data. If `path` is a\nrelative path, then it is resolved relative to the current working directory.", + "async": false, + "alias": "har", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "options", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.23", + "name": "notFound", + "type": { + "name": "HarNotFound", + "union": [ + { + "name": "\"abort\"" + }, + { + "name": "\"fallback\"" + } + ], + "expression": "[HarNotFound]<\"abort\"|\"fallback\">" + }, + "spec": [ + { + "type": "li", + "text": "If set to 'abort' any request not found in the HAR file will be aborted.", + "liType": "bullet" + }, + { + "type": "li", + "text": "If set to 'fallback' falls through to the next route handler in the handler chain.", + "liType": "bullet" + }, + { + "type": "text", + "text": "Defaults to abort." + } + ], + "required": false, + "comment": "- If set to 'abort' any request not found in the HAR file will be aborted.\n- If set to 'fallback' falls through to the next route handler in the handler chain.\n\nDefaults to abort.", + "async": false, + "alias": "notFound", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.23", + "name": "update", + "type": { + "name": "boolean", + "expression": "boolean" + }, + "spec": [ + { + "type": "text", + "text": "If specified, updates the given HAR with the actual network information instead of serving from file. The file is written to disk when [`method: BrowserContext.close`] is called." + } + ], + "required": false, + "comment": "If specified, updates the given HAR with the actual network information instead of serving from file. The file is\nwritten to disk when [`method: BrowserContext.close`] is called.", + "async": false, + "alias": "update", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.32", + "name": "updateContent", + "type": { + "name": "RouteFromHarUpdateContentPolicy", + "union": [ + { + "name": "\"embed\"" + }, + { + "name": "\"attach\"" + } + ], + "expression": "[RouteFromHarUpdateContentPolicy]<\"embed\"|\"attach\">" + }, + "spec": [ + { + "type": "text", + "text": "Optional setting to control resource content management. If `attach` is specified, resources are persisted as separate files or entries in the ZIP archive. If `embed` is specified, content is stored inline the HAR file." + } + ], + "required": false, + "comment": "Optional setting to control resource content management. If `attach` is specified, resources are persisted as\nseparate files or entries in the ZIP archive. If `embed` is specified, content is stored inline the HAR file.", + "async": false, + "alias": "updateContent", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.32", + "name": "updateMode", + "type": { + "name": "HarMode", + "union": [ + { + "name": "\"full\"" + }, + { + "name": "\"minimal\"" + } + ], + "expression": "[HarMode]<\"full\"|\"minimal\">" + }, + "spec": [ + { + "type": "text", + "text": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to `minimal`." + } + ], + "required": false, + "comment": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page,\ncookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to\n`minimal`.", + "async": false, + "alias": "updateMode", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.23", + "name": "url", + "type": { + "name": "", + "union": [ + { + "name": "string" + }, + { + "name": "RegExp" + } + ], + "expression": "[string]|[RegExp]" + }, + "spec": [ + { + "type": "text", + "text": "A glob pattern, regular expression or predicate to match the request URL. Only requests with URL matching the pattern will be served from the HAR file. If not specified, all requests are served from the HAR file." + } + ], + "required": false, + "comment": "A glob pattern, regular expression or predicate to match the request URL. Only requests with URL matching the\npattern will be served from the HAR file. If not specified, all requests are served from the HAR file.", + "async": false, + "alias": "url", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + "required": false, + "comment": "", + "async": false, + "alias": "options", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": { + "only": [ + "js", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.11", + "name": "serviceWorkers", + "type": { + "name": "Array", + "templates": [ + { + "name": "Worker" + } + ], + "expression": "[Array]<[Worker]>" + }, + "spec": [ + { + "type": "note", + "noteType": "note", + "text": "Service workers are only supported on Chromium-based browsers." + }, + { + "type": "text", + "text": "All existing service workers in the context." + } + ], + "required": true, + "comment": "**NOTE** Service workers are only supported on Chromium-based browsers.\n\nAll existing service workers in the context.", + "async": false, + "alias": "serviceWorkers", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "setDefaultNavigationTimeout", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "This setting will change the default maximum navigation time for the following methods and related shortcuts:" + }, + { + "type": "li", + "text": "[`method: Page.goBack`]", + "liType": "bullet" + }, + { + "type": "li", + "text": "[`method: Page.goForward`]", + "liType": "bullet" + }, + { + "type": "li", + "text": "[`method: Page.goto`]", + "liType": "bullet" + }, + { + "type": "li", + "text": "[`method: Page.reload`]", + "liType": "bullet" + }, + { + "type": "li", + "text": "[`method: Page.setContent`]", + "liType": "bullet" + }, + { + "type": "li", + "text": "[`method: Page.waitForNavigation`]", + "liType": "bullet" + }, + { + "type": "note", + "noteType": "note", + "text": "[`method: Page.setDefaultNavigationTimeout`] and [`method: Page.setDefaultTimeout`] take priority over↵[`method: BrowserContext.setDefaultNavigationTimeout`]." + } + ], + "required": true, + "comment": "This setting will change the default maximum navigation time for the following methods and related shortcuts:\n- [`method: Page.goBack`]\n- [`method: Page.goForward`]\n- [`method: Page.goto`]\n- [`method: Page.reload`]\n- [`method: Page.setContent`]\n- [`method: Page.waitForNavigation`]\n\n**NOTE** [`method: Page.setDefaultNavigationTimeout`] and [`method: Page.setDefaultTimeout`] take priority over\n[`method: BrowserContext.setDefaultNavigationTimeout`].", + "async": false, + "alias": "setDefaultNavigationTimeout", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "timeout", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Maximum navigation time in milliseconds" + } + ], + "required": true, + "comment": "Maximum navigation time in milliseconds", + "async": false, + "alias": "timeout", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "setDefaultTimeout", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "This setting will change the default maximum time for all the methods accepting `timeout` option." + }, + { + "type": "note", + "noteType": "note", + "text": "[`method: Page.setDefaultNavigationTimeout`], [`method: Page.setDefaultTimeout`] and↵[`method: BrowserContext.setDefaultNavigationTimeout`] take priority over [`method: BrowserContext.setDefaultTimeout`]." + } + ], + "required": true, + "comment": "This setting will change the default maximum time for all the methods accepting `timeout` option.\n\n**NOTE** [`method: Page.setDefaultNavigationTimeout`], [`method: Page.setDefaultTimeout`] and\n[`method: BrowserContext.setDefaultNavigationTimeout`] take priority over\n[`method: BrowserContext.setDefaultTimeout`].", + "async": false, + "alias": "setDefaultTimeout", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "timeout", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Maximum time in milliseconds" + } + ], + "required": true, + "comment": "Maximum time in milliseconds", + "async": false, + "alias": "timeout", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "setExtraHTTPHeaders", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "The extra HTTP headers will be sent with every request initiated by any page in the context. These headers are merged↵with page-specific extra HTTP headers set with [`method: Page.setExtraHTTPHeaders`]. If page overrides a particular↵header, page-specific header value will be used instead of the browser context header value." + }, + { + "type": "note", + "noteType": "note", + "text": "[`method: BrowserContext.setExtraHTTPHeaders`] does not guarantee the order of headers in the outgoing requests." + } + ], + "required": true, + "comment": "The extra HTTP headers will be sent with every request initiated by any page in the context. These headers are\nmerged with page-specific extra HTTP headers set with [`method: Page.setExtraHTTPHeaders`]. If page overrides a\nparticular header, page-specific header value will be used instead of the browser context header value.\n\n**NOTE** [`method: BrowserContext.setExtraHTTPHeaders`] does not guarantee the order of headers in the outgoing\nrequests.", + "async": true, + "alias": "setExtraHTTPHeaders", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "headers", + "type": { + "name": "Object", + "templates": [ + { + "name": "string" + }, + { + "name": "string" + } + ], + "expression": "[Object]<[string], [string]>" + }, + "spec": [ + { + "type": "text", + "text": "An object containing additional HTTP headers to be sent with every request. All header values must be strings." + } + ], + "required": true, + "comment": "An object containing additional HTTP headers to be sent with every request. All header values must be strings.", + "async": false, + "alias": "headers", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "setGeolocation", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "Sets the context's geolocation. Passing `null` or `undefined` emulates position unavailable." + }, + { + "type": "text", + "text": "**Usage**" + }, + { + "type": "code", + "lines": [ + "await browserContext.setGeolocation({latitude: 59.95, longitude: 30.31667});" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "browserContext.setGeolocation(new Geolocation(59.95, 30.31667));" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "await browser_context.set_geolocation({\"latitude\": 59.95, \"longitude\": 30.31667})" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "browser_context.set_geolocation({\"latitude\": 59.95, \"longitude\": 30.31667})" + ], + "codeLang": "python sync" + }, + { + "type": "code", + "lines": [ + "await context.SetGeolocationAsync(new Geolocation()", + "{", + " Latitude = 59.95f,", + " Longitude = 30.31667f", + "});" + ], + "codeLang": "csharp" + }, + { + "type": "note", + "noteType": "note", + "text": "Consider using [`method: BrowserContext.grantPermissions`] to grant permissions for the browser context pages to read↵its geolocation." + } + ], + "required": true, + "comment": "Sets the context's geolocation. Passing `null` or `undefined` emulates position unavailable.\n\n**Usage**\n\n```js\nawait browserContext.setGeolocation({latitude: 59.95, longitude: 30.31667});\n```\n\n```java\nbrowserContext.setGeolocation(new Geolocation(59.95, 30.31667));\n```\n\n```py\nawait browser_context.set_geolocation({\"latitude\": 59.95, \"longitude\": 30.31667})\n```\n\n```py\nbrowser_context.set_geolocation({\"latitude\": 59.95, \"longitude\": 30.31667})\n```\n\n```csharp\nawait context.SetGeolocationAsync(new Geolocation()\n{\n Latitude = 59.95f,\n Longitude = 30.31667f\n});\n```\n\n**NOTE** Consider using [`method: BrowserContext.grantPermissions`] to grant permissions for the browser context\npages to read its geolocation.", + "async": true, + "alias": "setGeolocation", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "geolocation", + "type": { + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "latitude", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Latitude between -90 and 90." + } + ], + "required": true, + "comment": "Latitude between -90 and 90.", + "async": false, + "alias": "latitude", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "longitude", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Longitude between -180 and 180." + } + ], + "required": true, + "comment": "Longitude between -180 and 180.", + "async": false, + "alias": "longitude", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "accuracy", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Non-negative accuracy value. Defaults to `0`." + } + ], + "required": false, + "comment": "Non-negative accuracy value. Defaults to `0`.", + "async": false, + "alias": "accuracy", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ], + "expression": "[null]|[Object]" + }, + "spec": [], + "required": true, + "comment": "", + "async": false, + "alias": "geolocation", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "deprecated": "Browsers may cache credentials after successful authentication. Create a new browser context instead.", + "name": "setHTTPCredentials", + "type": { + "name": "void" + }, + "spec": [], + "required": true, + "comment": "", + "async": true, + "alias": "setHTTPCredentials", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "httpCredentials", + "type": { + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "username", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "username", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "password", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "password", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ], + "expression": "[null]|[Object]" + }, + "spec": [], + "required": true, + "comment": "", + "async": false, + "alias": "httpCredentials", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "setOffline", + "type": { + "name": "void" + }, + "spec": [], + "required": true, + "comment": "", + "async": true, + "alias": "setOffline", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "offline", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Whether to emulate network being offline for the browser context." + } + ], + "required": true, + "comment": "Whether to emulate network being offline for the browser context.", + "async": false, + "alias": "offline", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": { + "types": { + "csharp": { + "name": "string", + "expression": "[string]" + }, + "java": { + "name": "string", + "expression": "[string]" + } + } + }, + "experimental": false, + "since": "v1.8", + "name": "storageState", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "cookies", + "type": { + "name": "Array", + "templates": [ + { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "name", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "name", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "value", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "value", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "domain", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "domain", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "path", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "path", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "expires", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Unix time in seconds." + } + ], + "required": true, + "comment": "Unix time in seconds.", + "async": false, + "alias": "expires", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "httpOnly", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "httpOnly", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "secure", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "secure", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "sameSite", + "type": { + "name": "SameSiteAttribute", + "union": [ + { + "name": "\"Strict\"" + }, + { + "name": "\"Lax\"" + }, + { + "name": "\"None\"" + } + ], + "expression": "[SameSiteAttribute]<\"Strict\"|\"Lax\"|\"None\">" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "sameSite", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ], + "expression": "[Array]<[Object]>" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "cookies", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "origins", + "type": { + "name": "Array", + "templates": [ + { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "origin", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "origin", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "localStorage", + "type": { + "name": "Array", + "templates": [ + { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "name", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "name", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "value", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "value", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ], + "expression": "[Array]<[Object]>" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "localStorage", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ], + "expression": "[Array]<[Object]>" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "origins", + "overloadIndex": 0, + "paramOrOption": null + } + ], + "expression": "[Object]" + }, + "spec": [ + { + "type": "text", + "text": "Returns storage state for this browser context, contains current cookies and local storage snapshot." + } + ], + "required": true, + "comment": "Returns storage state for this browser context, contains current cookies and local storage snapshot.", + "async": true, + "alias": "storageState", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "options", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "path", + "type": { + "name": "path", + "expression": "[path]" + }, + "spec": [ + { + "type": "text", + "text": "The file path to save the storage state to. If `path` is a relative path, then it is resolved relative to↵current working directory. If no path is provided, storage↵state is still returned, but won't be saved to the disk." + } + ], + "required": false, + "comment": "The file path to save the storage state to. If `path` is a relative path, then it is resolved relative to current\nworking directory. If no path is provided, storage state is still returned, but won't be saved to the disk.", + "async": false, + "alias": "path", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + "required": false, + "comment": "", + "async": false, + "alias": "options", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.12", + "name": "tracing", + "type": { + "name": "Tracing", + "expression": "[Tracing]" + }, + "spec": [], + "required": true, + "comment": "", + "async": false, + "alias": "tracing", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "unroute", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "Removes a route created with [`method: BrowserContext.route`]. When `handler` is not specified, removes all↵routes for the `url`." + } + ], + "required": true, + "comment": "Removes a route created with [`method: BrowserContext.route`]. When `handler` is not specified, removes all routes\nfor the `url`.", + "async": true, + "alias": "unroute", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "url", + "type": { + "name": "", + "union": [ + { + "name": "string" + }, + { + "name": "RegExp" + }, + { + "name": "function", + "args": [ + { + "name": "URL" + } + ], + "returnType": { + "name": "boolean" + } + } + ], + "expression": "[string]|[RegExp]|[function]([URL]):[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "A glob pattern, regex pattern or predicate receiving [URL] used to register a routing with↵[`method: BrowserContext.route`]." + } + ], + "required": true, + "comment": "A glob pattern, regex pattern or predicate receiving [URL] used to register a routing with\n[`method: BrowserContext.route`].", + "async": false, + "alias": "url", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "handler", + "type": { + "name": "function", + "args": [ + { + "name": "Route" + }, + { + "name": "Request" + } + ], + "returnType": { + "name": "", + "union": [ + { + "name": "Promise", + "templates": [ + { + "name": "any" + } + ] + }, + { + "name": "any" + } + ] + }, + "expression": "[function]([Route], [Request]): [Promise|any]" + }, + "spec": [ + { + "type": "text", + "text": "Optional handler function used to register a routing with [`method: BrowserContext.route`]." + } + ], + "required": false, + "comment": "Optional handler function used to register a routing with [`method: BrowserContext.route`].", + "async": false, + "alias": "handler", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "handler", + "type": { + "name": "function", + "args": [ + { + "name": "Route" + } + ], + "expression": "[function]([Route])" + }, + "spec": [ + { + "type": "text", + "text": "Optional handler function used to register a routing with [`method: BrowserContext.route`]." + } + ], + "required": false, + "comment": "Optional handler function used to register a routing with [`method: BrowserContext.route`].", + "async": false, + "alias": "handler", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": { + "only": [ + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.32", + "name": "waitForCondition", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "The method will block until the condition returns true. All Playwright events will↵be dispatched while the method is waiting for the condition." + }, + { + "type": "text", + "text": "**Usage**" + }, + { + "type": "text", + "text": "Use the method to wait for a condition that depends on page events:" + }, + { + "type": "code", + "lines": [ + "List failedUrls = new ArrayList<>();", + "context.onResponse(response -> {", + " if (!response.ok()) {", + " failedUrls.add(response.url());", + " }", + "});", + "page1.getByText(\"Create user\").click();", + "page2.getByText(\"Submit button\").click();", + "context.waitForCondition(() -> failedUrls.size() > 3);" + ], + "codeLang": "java" + } + ], + "required": true, + "comment": "The method will block until the condition returns true. All Playwright events will be dispatched while the method\nis waiting for the condition.\n\n**Usage**\n\nUse the method to wait for a condition that depends on page events:\n\n```java\nList failedUrls = new ArrayList<>();\ncontext.onResponse(response -> {\n if (!response.ok()) {\n failedUrls.add(response.url());\n }\n});\npage1.getByText(\"Create user\").click();\npage2.getByText(\"Submit button\").click();\ncontext.waitForCondition(() -> failedUrls.size() > 3);\n```\n", + "async": true, + "alias": "waitForCondition", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.32", + "name": "condition", + "type": { + "name": "BooleanSupplier", + "expression": "[BooleanSupplier]" + }, + "spec": [ + { + "type": "text", + "text": "Condition to wait for." + } + ], + "required": true, + "comment": "Condition to wait for.", + "async": false, + "alias": "condition", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "options", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": { + "only": [ + "python", + "java", + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.32", + "name": "timeout", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default↵value can be changed by using the [`method: BrowserContext.setDefaultTimeout`] or [`method: Page.setDefaultTimeout`] methods." + } + ], + "required": false, + "comment": "Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The\ndefault value can be changed by using the [`method: BrowserContext.setDefaultTimeout`] or\n[`method: Page.setDefaultTimeout`] methods.", + "async": false, + "alias": "timeout", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + "required": false, + "comment": "", + "async": false, + "alias": "options", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": { + "only": [ + "js", + "python" + ], + "aliases": { + "python": "expect_event" + }, + "types": { + "python": { + "name": "EventContextManager", + "expression": "[EventContextManager]" + } + }, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "waitForEvent", + "type": { + "name": "any", + "expression": "[any]" + }, + "spec": [ + { + "type": "text", + "text": "Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy↵value. Will throw an error if the context closes before the event is fired. Returns the event data value." + }, + { + "type": "text", + "text": "**Usage**" + }, + { + "type": "code", + "lines": [ + "const pagePromise = context.waitForEvent('page');", + "await page.getByRole('button').click();", + "const page = await pagePromise;" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "Page newPage = context.waitForPage(() -> page.getByRole(AriaRole.BUTTON).click());" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "async with context.expect_event(\"page\") as event_info:", + " await page.get_by_role(\"button\").click()", + "page = await event_info.value" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "with context.expect_event(\"page\") as event_info:", + " page.get_by_role(\"button\").click()", + "page = event_info.value" + ], + "codeLang": "python sync" + }, + { + "type": "code", + "lines": [ + "var page = await context.RunAndWaitForPageAsync(async () =>", + "{", + " await page.GetByRole(AriaRole.Button).ClickAsync();", + "});" + ], + "codeLang": "csharp" + } + ], + "required": true, + "comment": "Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy\nvalue. Will throw an error if the context closes before the event is fired. Returns the event data value.\n\n**Usage**\n\n```js\nconst pagePromise = context.waitForEvent('page');\nawait page.getByRole('button').click();\nconst page = await pagePromise;\n```\n\n```java\nPage newPage = context.waitForPage(() -> page.getByRole(AriaRole.BUTTON).click());\n```\n\n```py\nasync with context.expect_event(\"page\") as event_info:\n await page.get_by_role(\"button\").click()\npage = await event_info.value\n```\n\n```py\nwith context.expect_event(\"page\") as event_info:\n page.get_by_role(\"button\").click()\npage = event_info.value\n```\n\n```csharp\nvar page = await context.RunAndWaitForPageAsync(async () =>\n{\n await page.GetByRole(AriaRole.Button).ClickAsync();\n});\n```\n", + "async": true, + "alias": "waitForEvent", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "event", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Event name, same one would pass into `browserContext.on(event)`." + } + ], + "required": true, + "comment": "Event name, same one would pass into `browserContext.on(event)`.", + "async": false, + "alias": "event", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "optionsOrPredicate", + "type": { + "name": "", + "union": [ + { + "name": "function" + }, + { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "predicate", + "type": { + "name": "function", + "expression": "[function]" + }, + "spec": [ + { + "type": "text", + "text": "Receives the event data and resolves to truthy value when the waiting should resolve." + } + ], + "required": true, + "comment": "Receives the event data and resolves to truthy value when the waiting should resolve.", + "async": false, + "alias": "predicate", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "timeout", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Maximum time to wait for in milliseconds. Defaults to `0` - no timeout. The default value can be changed via `actionTimeout` option in the config, or by using the [`method: BrowserContext.setDefaultTimeout`] method." + } + ], + "required": false, + "comment": "Maximum time to wait for in milliseconds. Defaults to `0` - no timeout. The default value can be changed via\n`actionTimeout` option in the config, or by using the [`method: BrowserContext.setDefaultTimeout`] method.", + "async": false, + "alias": "timeout", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ], + "expression": "[function]|[Object]" + }, + "spec": [ + { + "type": "text", + "text": "Either a predicate that receives an event or an options object. Optional." + } + ], + "required": false, + "comment": "Either a predicate that receives an event or an options object. Optional.", + "async": false, + "alias": "optionsOrPredicate", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "options", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "predicate", + "type": { + "name": "function", + "expression": "[function]" + }, + "spec": [ + { + "type": "text", + "text": "Receives the event data and resolves to truthy value when the waiting should resolve." + } + ], + "required": false, + "comment": "Receives the event data and resolves to truthy value when the waiting should resolve.", + "async": false, + "alias": "predicate", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "java", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "timeout", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.↵The default value can be changed by using the [`method: BrowserContext.setDefaultTimeout`]." + } + ], + "required": false, + "comment": "Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The\ndefault value can be changed by using the [`method: BrowserContext.setDefaultTimeout`].", + "async": false, + "alias": "timeout", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + "required": false, + "comment": "", + "async": false, + "alias": "options", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": { + "only": [ + "java", + "python", + "csharp" + ], + "aliases": { + "python": "expect_page", + "csharp": "RunAndWaitForPage" + }, + "types": { + "python": { + "name": "EventContextManager", + "templates": [ + { + "name": "Page" + } + ], + "expression": "[EventContextManager]<[Page]>" + } + }, + "overrides": {} + }, + "experimental": false, + "since": "v1.9", + "name": "waitForPage", + "type": { + "name": "Page", + "expression": "[Page]" + }, + "spec": [ + { + "type": "text", + "text": "Performs action and waits for a new `Page` to be created in the context. If predicate is provided, it passes↵`Page` value into the `predicate` function and waits for `predicate(event)` to return a truthy value.↵Will throw an error if the context closes before new `Page` is created." + } + ], + "required": true, + "comment": "Performs action and waits for a new `Page` to be created in the context. If predicate is provided, it passes `Page`\nvalue into the `predicate` function and waits for `predicate(event)` to return a truthy value. Will throw an error\nif the context closes before new `Page` is created.", + "async": true, + "alias": "waitForPage", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": { + "only": [ + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.12", + "name": "action", + "type": { + "name": "Func", + "templates": [ + { + "name": "Task" + } + ], + "expression": "[Func]" + }, + "spec": [ + { + "type": "text", + "text": "Action that triggers the event." + } + ], + "required": true, + "comment": "Action that triggers the event.", + "async": false, + "alias": "action", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "options", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "java", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.9", + "name": "predicate", + "type": { + "name": "function", + "args": [ + { + "name": "Page" + } + ], + "returnType": { + "name": "boolean" + }, + "expression": "[function]([Page]):[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Receives the `Page` object and resolves to truthy value when the waiting should resolve." + } + ], + "required": false, + "comment": "Receives the `Page` object and resolves to truthy value when the waiting should resolve.", + "async": false, + "alias": "predicate", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "java", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.9", + "name": "timeout", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.↵The default value can be changed by using the [`method: BrowserContext.setDefaultTimeout`]." + } + ], + "required": false, + "comment": "Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The\ndefault value can be changed by using the [`method: BrowserContext.setDefaultTimeout`].", + "async": false, + "alias": "timeout", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + "required": false, + "comment": "", + "async": false, + "alias": "options", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.9", + "name": "callback", + "type": { + "name": "Runnable", + "expression": "[Runnable]" + }, + "spec": [ + { + "type": "text", + "text": "Callback that performs the action triggering the event." + } + ], + "required": true, + "comment": "Callback that performs the action triggering the event.", + "async": false, + "alias": "callback", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": { + "only": [ + "python" + ], + "aliases": { + "python": "wait_for_event" + }, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "waitForEvent2", + "type": { + "name": "any", + "expression": "[any]" + }, + "spec": [ + { + "type": "note", + "noteType": "note", + "text": "In most cases, you should use [`method: BrowserContext.waitForEvent`]." + }, + { + "type": "text", + "text": "Waits for given `event` to fire. If predicate is provided, it passes↵event's value into the `predicate` function and waits for `predicate(event)` to return a truthy value.↵Will throw an error if the browser context is closed before the `event` is fired." + } + ], + "required": true, + "comment": "**NOTE** In most cases, you should use [`method: BrowserContext.waitForEvent`].\n\nWaits for given `event` to fire. If predicate is provided, it passes event's value into the `predicate` function\nand waits for `predicate(event)` to return a truthy value. Will throw an error if the browser context is closed\nbefore the `event` is fired.", + "async": true, + "alias": "waitForEvent2", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": { + "only": [ + "js", + "python", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "event", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Event name, same one typically passed into `*.on(event)`." + } + ], + "required": true, + "comment": "Event name, same one typically passed into `*.on(event)`.", + "async": false, + "alias": "event", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "options", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "predicate", + "type": { + "name": "function", + "expression": "[function]" + }, + "spec": [ + { + "type": "text", + "text": "Receives the event data and resolves to truthy value when the waiting should resolve." + } + ], + "required": false, + "comment": "Receives the event data and resolves to truthy value when the waiting should resolve.", + "async": false, + "alias": "predicate", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "java", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "timeout", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.↵The default value can be changed by using the [`method: BrowserContext.setDefaultTimeout`]." + } + ], + "required": false, + "comment": "Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The\ndefault value can be changed by using the [`method: BrowserContext.setDefaultTimeout`].", + "async": false, + "alias": "timeout", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + "required": false, + "comment": "", + "async": false, + "alias": "options", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ] + }, + { + "name": "BrowserServer", + "spec": [], + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "since": "v1.8", + "members": [ + { + "kind": "event", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "close", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "Emitted when the browser server closes." + } + ], + "required": true, + "comment": "Emitted when the browser server closes.", + "async": false, + "alias": "close", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "close", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "Closes the browser gracefully and makes sure the process is terminated." + } + ], + "required": true, + "comment": "Closes the browser gracefully and makes sure the process is terminated.", + "async": true, + "alias": "close", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "kill", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "Kills the browser process and waits for the process to exit." + } + ], + "required": true, + "comment": "Kills the browser process and waits for the process to exit.", + "async": true, + "alias": "kill", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "process", + "type": { + "name": "ChildProcess", + "expression": "[ChildProcess]" + }, + "spec": [ + { + "type": "text", + "text": "Spawned browser application process." + } + ], + "required": true, + "comment": "Spawned browser application process.", + "async": false, + "alias": "process", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "wsEndpoint", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Browser websocket url." + }, + { + "type": "text", + "text": "Browser websocket endpoint which can be used as an argument to [`method: BrowserType.connect`] to establish connection↵to the browser." + } + ], + "required": true, + "comment": "Browser websocket url.\n\nBrowser websocket endpoint which can be used as an argument to [`method: BrowserType.connect`] to establish\nconnection to the browser.", + "async": false, + "alias": "wsEndpoint", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + } + ] + }, + { + "name": "BrowserType", + "spec": [ + { + "type": "text", + "text": "BrowserType provides methods to launch a specific browser instance or connect to an existing one. The following is a↵typical example of using Playwright to drive automation:" + }, + { + "type": "code", + "lines": [ + "const { chromium } = require('playwright'); // Or 'firefox' or 'webkit'.", + "", + "(async () => {", + " const browser = await chromium.launch();", + " const page = await browser.newPage();", + " await page.goto('https://example.com');", + " // other actions...", + " await browser.close();", + "})();" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "import com.microsoft.playwright.*;", + "", + "public class Example {", + " public static void main(String[] args) {", + " try (Playwright playwright = Playwright.create()) {", + " BrowserType chromium = playwright.chromium();", + " Browser browser = chromium.launch();", + " Page page = browser.newPage();", + " page.navigate(\"https://example.com\");", + " // other actions...", + " browser.close();", + " }", + " }", + "}" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "import asyncio", + "from playwright.async_api import async_playwright", + "", + "async def run(playwright):", + " chromium = playwright.chromium", + " browser = await chromium.launch()", + " page = await browser.new_page()", + " await page.goto(\"https://example.com\")", + " # other actions...", + " await browser.close()", + "", + "async def main():", + " async with async_playwright() as playwright:", + " await run(playwright)", + "asyncio.run(main())" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "from playwright.sync_api import sync_playwright", + "", + "def run(playwright):", + " chromium = playwright.chromium", + " browser = chromium.launch()", + " page = browser.new_page()", + " page.goto(\"https://example.com\")", + " # other actions...", + " browser.close()", + "", + "with sync_playwright() as playwright:", + " run(playwright)" + ], + "codeLang": "python sync" + }, + { + "type": "code", + "lines": [ + "using Microsoft.Playwright;", + "using System.Threading.Tasks;", + "", + "class BrowserTypeExamples", + "{", + " public static async Task Run()", + " {", + " using var playwright = await Playwright.CreateAsync();", + " var chromium = playwright.Chromium;", + " var browser = await chromium.LaunchAsync();", + " var page = await browser.NewPageAsync();", + " await page.GotoAsync(\"https://www.bing.com\");", + " // other actions", + " await browser.CloseAsync();", + " }", + "}" + ], + "codeLang": "csharp" + } + ], + "langs": {}, + "comment": "BrowserType provides methods to launch a specific browser instance or connect to an existing one. The following is\na typical example of using Playwright to drive automation:\n\n```js\nconst { chromium } = require('playwright'); // Or 'firefox' or 'webkit'.\n\n(async () => {\n const browser = await chromium.launch();\n const page = await browser.newPage();\n await page.goto('https://example.com');\n // other actions...\n await browser.close();\n})();\n```\n\n```java\nimport com.microsoft.playwright.*;\n\npublic class Example {\n public static void main(String[] args) {\n try (Playwright playwright = Playwright.create()) {\n BrowserType chromium = playwright.chromium();\n Browser browser = chromium.launch();\n Page page = browser.newPage();\n page.navigate(\"https://example.com\");\n // other actions...\n browser.close();\n }\n }\n}\n```\n\n```py\nimport asyncio\nfrom playwright.async_api import async_playwright\n\nasync def run(playwright):\n chromium = playwright.chromium\n browser = await chromium.launch()\n page = await browser.new_page()\n await page.goto(\"https://example.com\")\n # other actions...\n await browser.close()\n\nasync def main():\n async with async_playwright() as playwright:\n await run(playwright)\nasyncio.run(main())\n```\n\n```py\nfrom playwright.sync_api import sync_playwright\n\ndef run(playwright):\n chromium = playwright.chromium\n browser = chromium.launch()\n page = browser.new_page()\n page.goto(\"https://example.com\")\n # other actions...\n browser.close()\n\nwith sync_playwright() as playwright:\n run(playwright)\n```\n\n```csharp\nusing Microsoft.Playwright;\nusing System.Threading.Tasks;\n\nclass BrowserTypeExamples\n{\n public static async Task Run()\n {\n using var playwright = await Playwright.CreateAsync();\n var chromium = playwright.Chromium;\n var browser = await chromium.LaunchAsync();\n var page = await browser.NewPageAsync();\n await page.GotoAsync(\"https://www.bing.com\");\n // other actions\n await browser.CloseAsync();\n }\n}\n```\n", + "since": "v1.8", + "members": [ + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "connect", + "type": { + "name": "Browser", + "expression": "[Browser]" + }, + "spec": [ + { + "type": "text", + "text": "This method attaches Playwright to an existing browser instance. When connecting to another browser launched via `BrowserType.launchServer` in Node.js, the major and minor version needs to match the client version (1.2.3 → is compatible with 1.2.x)." + } + ], + "required": true, + "comment": "This method attaches Playwright to an existing browser instance. When connecting to another browser launched via\n`BrowserType.launchServer` in Node.js, the major and minor version needs to match the client version (1.2.3 → is\ncompatible with 1.2.x).", + "async": true, + "alias": "connect", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.10", + "name": "wsEndpoint", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "A browser websocket endpoint to connect to." + } + ], + "required": true, + "comment": "A browser websocket endpoint to connect to.", + "async": false, + "alias": "wsEndpoint", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "options", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.11", + "name": "headers", + "type": { + "name": "Object", + "templates": [ + { + "name": "string" + }, + { + "name": "string" + } + ], + "expression": "[Object]<[string], [string]>" + }, + "spec": [ + { + "type": "text", + "text": "Additional HTTP headers to be sent with web socket connect request. Optional." + } + ], + "required": false, + "comment": "Additional HTTP headers to be sent with web socket connect request. Optional.", + "async": false, + "alias": "headers", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.14", + "name": "logger", + "type": { + "name": "Logger", + "expression": "[Logger]" + }, + "spec": [ + { + "type": "text", + "text": "Logger sink for Playwright logging. Optional." + } + ], + "required": false, + "comment": "Logger sink for Playwright logging. Optional.", + "async": false, + "alias": "logger", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.10", + "name": "slowMo", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Slows down Playwright operations by the specified amount of milliseconds. Useful so that you↵can see what is going on. Defaults to 0." + } + ], + "required": false, + "comment": "Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going\non. Defaults to 0.", + "async": false, + "alias": "slowMo", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.10", + "name": "timeout", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Maximum time in milliseconds to wait for the connection to be established. Defaults to↵`0` (no timeout)." + } + ], + "required": false, + "comment": "Maximum time in milliseconds to wait for the connection to be established. Defaults to `0` (no timeout).", + "async": false, + "alias": "timeout", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + "required": false, + "comment": "", + "async": false, + "alias": "options", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.9", + "name": "connectOverCDP", + "type": { + "name": "Browser", + "expression": "[Browser]" + }, + "spec": [ + { + "type": "text", + "text": "This method attaches Playwright to an existing browser instance using the Chrome DevTools Protocol." + }, + { + "type": "text", + "text": "The default browser context is accessible via [`method: Browser.contexts`]." + }, + { + "type": "note", + "noteType": "note", + "text": "Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers." + }, + { + "type": "text", + "text": "**Usage**" + }, + { + "type": "code", + "lines": [ + "const browser = await playwright.chromium.connectOverCDP('http://localhost:9222');", + "const defaultContext = browser.contexts()[0];", + "const page = defaultContext.pages()[0];" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "Browser browser = playwright.chromium().connectOverCDP(\"http://localhost:9222\");", + "BrowserContext defaultContext = browser.contexts().get(0);", + "Page page = defaultContext.pages().get(0);" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "browser = await playwright.chromium.connect_over_cdp(\"http://localhost:9222\")", + "default_context = browser.contexts[0]", + "page = default_context.pages[0]" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "browser = playwright.chromium.connect_over_cdp(\"http://localhost:9222\")", + "default_context = browser.contexts[0]", + "page = default_context.pages[0]" + ], + "codeLang": "python sync" + }, + { + "type": "code", + "lines": [ + "var browser = await playwright.Chromium.ConnectOverCDPAsync(\"http://localhost:9222\");", + "var defaultContext = browser.Contexts[0];", + "var page = defaultContext.Pages[0];" + ], + "codeLang": "csharp" + } + ], + "required": true, + "comment": "This method attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.\n\nThe default browser context is accessible via [`method: Browser.contexts`].\n\n**NOTE** Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.\n\n**Usage**\n\n```js\nconst browser = await playwright.chromium.connectOverCDP('http://localhost:9222');\nconst defaultContext = browser.contexts()[0];\nconst page = defaultContext.pages()[0];\n```\n\n```java\nBrowser browser = playwright.chromium().connectOverCDP(\"http://localhost:9222\");\nBrowserContext defaultContext = browser.contexts().get(0);\nPage page = defaultContext.pages().get(0);\n```\n\n```py\nbrowser = await playwright.chromium.connect_over_cdp(\"http://localhost:9222\")\ndefault_context = browser.contexts[0]\npage = default_context.pages[0]\n```\n\n```py\nbrowser = playwright.chromium.connect_over_cdp(\"http://localhost:9222\")\ndefault_context = browser.contexts[0]\npage = default_context.pages[0]\n```\n\n```csharp\nvar browser = await playwright.Chromium.ConnectOverCDPAsync(\"http://localhost:9222\");\nvar defaultContext = browser.Contexts[0];\nvar page = defaultContext.Pages[0];\n```\n", + "async": true, + "alias": "connectOverCDP", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.11", + "name": "endpointURL", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "A CDP websocket endpoint or http url to connect to. For example `http://localhost:9222/` or `ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4`." + } + ], + "required": true, + "comment": "A CDP websocket endpoint or http url to connect to. For example `http://localhost:9222/` or\n`ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4`.", + "async": false, + "alias": "endpointURL", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "options", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.14", + "name": "endpointURL", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Deprecated, use the first argument instead. Optional." + } + ], + "required": false, + "comment": "Deprecated, use the first argument instead. Optional.", + "async": false, + "alias": "endpointURL", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.11", + "name": "headers", + "type": { + "name": "Object", + "templates": [ + { + "name": "string" + }, + { + "name": "string" + } + ], + "expression": "[Object]<[string], [string]>" + }, + "spec": [ + { + "type": "text", + "text": "Additional HTTP headers to be sent with connect request. Optional." + } + ], + "required": false, + "comment": "Additional HTTP headers to be sent with connect request. Optional.", + "async": false, + "alias": "headers", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.14", + "name": "logger", + "type": { + "name": "Logger", + "expression": "[Logger]" + }, + "spec": [ + { + "type": "text", + "text": "Logger sink for Playwright logging. Optional." + } + ], + "required": false, + "comment": "Logger sink for Playwright logging. Optional.", + "async": false, + "alias": "logger", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.11", + "name": "slowMo", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Slows down Playwright operations by the specified amount of milliseconds. Useful so that you↵can see what is going on. Defaults to 0." + } + ], + "required": false, + "comment": "Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going\non. Defaults to 0.", + "async": false, + "alias": "slowMo", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.11", + "name": "timeout", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Maximum time in milliseconds to wait for the connection to be established. Defaults to↵`30000` (30 seconds). Pass `0` to disable timeout." + } + ], + "required": false, + "comment": "Maximum time in milliseconds to wait for the connection to be established. Defaults to `30000` (30 seconds). Pass\n`0` to disable timeout.", + "async": false, + "alias": "timeout", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + "required": false, + "comment": "", + "async": false, + "alias": "options", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "executablePath", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "A path where Playwright expects to find a bundled browser executable." + } + ], + "required": true, + "comment": "A path where Playwright expects to find a bundled browser executable.", + "async": false, + "alias": "executablePath", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "launch", + "type": { + "name": "Browser", + "expression": "[Browser]" + }, + "spec": [ + { + "type": "text", + "text": "Returns the browser instance." + }, + { + "type": "text", + "text": "**Usage**" + }, + { + "type": "text", + "text": "You can use `ignoreDefaultArgs` to filter out `--mute-audio` from default arguments:" + }, + { + "type": "code", + "lines": [ + "const browser = await chromium.launch({ // Or 'firefox' or 'webkit'.", + " ignoreDefaultArgs: ['--mute-audio']", + "});" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "// Or \"firefox\" or \"webkit\".", + "Browser browser = chromium.launch(new BrowserType.LaunchOptions()", + " .setIgnoreDefaultArgs(Arrays.asList(\"--mute-audio\")));" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "browser = await playwright.chromium.launch( # or \"firefox\" or \"webkit\".", + " ignore_default_args=[\"--mute-audio\"]", + ")" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "browser = playwright.chromium.launch( # or \"firefox\" or \"webkit\".", + " ignore_default_args=[\"--mute-audio\"]", + ")" + ], + "codeLang": "python sync" + }, + { + "type": "code", + "lines": [ + "var browser = await playwright.Chromium.LaunchAsync(new() {", + " IgnoreDefaultArgs = new[] { \"--mute-audio\" }", + "})" + ], + "codeLang": "csharp" + }, + { + "type": "text", + "text": "> **Chromium-only** Playwright can also be used to control the Google Chrome or Microsoft Edge browsers, but it works best with the version of↵Chromium it is bundled with. There is no guarantee it will work with any other version. Use `executablePath`↵option with extreme caution." + }, + { + "type": "text", + "text": ">" + }, + { + "type": "text", + "text": "> If Google Chrome (rather than Chromium) is preferred, a↵[Chrome Canary](https://www.google.com/chrome/browser/canary.html) or↵[Dev Channel](https://www.chromium.org/getting-involved/dev-channel) build is suggested." + }, + { + "type": "text", + "text": ">" + }, + { + "type": "text", + "text": "> Stock browsers like Google Chrome and Microsoft Edge are suitable for tests that require proprietary media codecs for video playback. See [this article](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for other differences between Chromium and Chrome.↵[This article](https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md)↵describes some differences for Linux users." + } + ], + "required": true, + "comment": "Returns the browser instance.\n\n**Usage**\n\nYou can use `ignoreDefaultArgs` to filter out `--mute-audio` from default arguments:\n\n```js\nconst browser = await chromium.launch({ // Or 'firefox' or 'webkit'.\n ignoreDefaultArgs: ['--mute-audio']\n});\n```\n\n```java\n// Or \"firefox\" or \"webkit\".\nBrowser browser = chromium.launch(new BrowserType.LaunchOptions()\n .setIgnoreDefaultArgs(Arrays.asList(\"--mute-audio\")));\n```\n\n```py\nbrowser = await playwright.chromium.launch( # or \"firefox\" or \"webkit\".\n ignore_default_args=[\"--mute-audio\"]\n)\n```\n\n```py\nbrowser = playwright.chromium.launch( # or \"firefox\" or \"webkit\".\n ignore_default_args=[\"--mute-audio\"]\n)\n```\n\n```csharp\nvar browser = await playwright.Chromium.LaunchAsync(new() {\n IgnoreDefaultArgs = new[] { \"--mute-audio\" }\n})\n```\n\n> **Chromium-only** Playwright can also be used to control the Google Chrome or Microsoft Edge browsers, but it\nworks best with the version of Chromium it is bundled with. There is no guarantee it will work with any other\nversion. Use `executablePath` option with extreme caution.\n>\n> If Google Chrome (rather than Chromium) is preferred, a\n[Chrome Canary](https://www.google.com/chrome/browser/canary.html) or\n[Dev Channel](https://www.chromium.org/getting-involved/dev-channel) build is suggested.\n>\n> Stock browsers like Google Chrome and Microsoft Edge are suitable for tests that require proprietary media codecs\nfor video playback. See\n[this article](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for\nother differences between Chromium and Chrome.\n[This article](https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md)\ndescribes some differences for Linux users.", + "async": true, + "alias": "launch", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "options", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "args", + "type": { + "name": "Array", + "templates": [ + { + "name": "string" + } + ], + "expression": "[Array]<[string]>" + }, + "spec": [ + { + "type": "text", + "text": "Additional arguments to pass to the browser instance. The list of Chromium flags can be found↵[here](http://peter.sh/experiments/chromium-command-line-switches/)." + } + ], + "required": false, + "comment": "Additional arguments to pass to the browser instance. The list of Chromium flags can be found\n[here](http://peter.sh/experiments/chromium-command-line-switches/).", + "async": false, + "alias": "args", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "channel", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Browser distribution channel. Supported values are \"chrome\", \"chrome-beta\", \"chrome-dev\", \"chrome-canary\", \"msedge\", \"msedge-beta\", \"msedge-dev\", \"msedge-canary\". Read more about using [Google Chrome and Microsoft Edge](../browsers.md#google-chrome--microsoft-edge)." + } + ], + "required": false, + "comment": "Browser distribution channel. Supported values are \"chrome\", \"chrome-beta\", \"chrome-dev\", \"chrome-canary\",\n\"msedge\", \"msedge-beta\", \"msedge-dev\", \"msedge-canary\". Read more about using\n[Google Chrome and Microsoft Edge](../browsers.md#google-chrome--microsoft-edge).", + "async": false, + "alias": "channel", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "chromiumSandbox", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Enable Chromium sandboxing. Defaults to `false`." + } + ], + "required": false, + "comment": "Enable Chromium sandboxing. Defaults to `false`.", + "async": false, + "alias": "chromiumSandbox", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "devtools", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "**Chromium-only** Whether to auto-open a Developer Tools panel for each tab. If this option is `true`, the↵`headless` option will be set `false`." + } + ], + "required": false, + "comment": "**Chromium-only** Whether to auto-open a Developer Tools panel for each tab. If this option is `true`, the\n`headless` option will be set `false`.", + "async": false, + "alias": "devtools", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "downloadsPath", + "type": { + "name": "path", + "expression": "[path]" + }, + "spec": [ + { + "type": "text", + "text": "If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is↵deleted when browser is closed. In either case, the downloads are deleted when the browser context they were created in↵is closed." + } + ], + "required": false, + "comment": "If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and\nis deleted when browser is closed. In either case, the downloads are deleted when the browser context they were\ncreated in is closed.", + "async": false, + "alias": "downloadsPath", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "env", + "type": { + "name": "Object", + "templates": [ + { + "name": "string" + }, + { + "name": "string" + } + ], + "expression": "[Object]<[string], [string]>" + }, + "spec": [ + { + "type": "text", + "text": "Specify environment variables that will be visible to the browser. Defaults to `process.env`." + } + ], + "required": false, + "comment": "Specify environment variables that will be visible to the browser. Defaults to `process.env`.", + "async": false, + "alias": "env", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "env", + "type": { + "name": "Object", + "templates": [ + { + "name": "string" + }, + { + "name": "", + "union": [ + { + "name": "string" + }, + { + "name": "float" + }, + { + "name": "boolean" + } + ] + } + ], + "expression": "[Object]<[string], [string]|[float]|[boolean]>" + }, + "spec": [ + { + "type": "text", + "text": "Specify environment variables that will be visible to the browser. Defaults to `process.env`." + } + ], + "required": false, + "comment": "Specify environment variables that will be visible to the browser. Defaults to `process.env`.", + "async": false, + "alias": "env", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "executablePath", + "type": { + "name": "path", + "expression": "[path]" + }, + "spec": [ + { + "type": "text", + "text": "Path to a browser executable to run instead of the bundled one. If `executablePath` is a relative path, then↵it is resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium,↵Firefox or WebKit, use at your own risk." + } + ], + "required": false, + "comment": "Path to a browser executable to run instead of the bundled one. If `executablePath` is a relative path, then it is\nresolved relative to the current working directory. Note that Playwright only works with the bundled Chromium,\nFirefox or WebKit, use at your own risk.", + "async": false, + "alias": "executablePath", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "firefoxUserPrefs", + "type": { + "name": "Object", + "templates": [ + { + "name": "string" + }, + { + "name": "", + "union": [ + { + "name": "string" + }, + { + "name": "float" + }, + { + "name": "boolean" + } + ] + } + ], + "expression": "[Object]<[string], [string]|[float]|[boolean]>" + }, + "spec": [ + { + "type": "text", + "text": "Firefox user preferences. Learn more about the Firefox user preferences at↵[`about:config`](https://support.mozilla.org/en-US/kb/about-config-editor-firefox)." + } + ], + "required": false, + "comment": "Firefox user preferences. Learn more about the Firefox user preferences at\n[`about:config`](https://support.mozilla.org/en-US/kb/about-config-editor-firefox).", + "async": false, + "alias": "firefoxUserPrefs", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "firefoxUserPrefs", + "type": { + "name": "Object", + "templates": [ + { + "name": "string" + }, + { + "name": "any" + } + ], + "expression": "[Object]<[string], [any]>" + }, + "spec": [ + { + "type": "text", + "text": "Firefox user preferences. Learn more about the Firefox user preferences at↵[`about:config`](https://support.mozilla.org/en-US/kb/about-config-editor-firefox)." + } + ], + "required": false, + "comment": "Firefox user preferences. Learn more about the Firefox user preferences at\n[`about:config`](https://support.mozilla.org/en-US/kb/about-config-editor-firefox).", + "async": false, + "alias": "firefoxUserPrefs", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "handleSIGHUP", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Close the browser process on SIGHUP. Defaults to `true`." + } + ], + "required": false, + "comment": "Close the browser process on SIGHUP. Defaults to `true`.", + "async": false, + "alias": "handleSIGHUP", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "handleSIGINT", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Close the browser process on Ctrl-C. Defaults to `true`." + } + ], + "required": false, + "comment": "Close the browser process on Ctrl-C. Defaults to `true`.", + "async": false, + "alias": "handleSIGINT", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "handleSIGTERM", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Close the browser process on SIGTERM. Defaults to `true`." + } + ], + "required": false, + "comment": "Close the browser process on SIGTERM. Defaults to `true`.", + "async": false, + "alias": "handleSIGTERM", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "headless", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Whether to run browser in headless mode. More details for↵[Chromium](https://developers.google.com/web/updates/2017/04/headless-chrome) and↵[Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Firefox/Headless_mode). Defaults to `true` unless the↵`devtools` option is `true`." + } + ], + "required": false, + "comment": "Whether to run browser in headless mode. More details for\n[Chromium](https://developers.google.com/web/updates/2017/04/headless-chrome) and\n[Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Firefox/Headless_mode). Defaults to `true` unless the\n`devtools` option is `true`.", + "async": false, + "alias": "headless", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.9", + "name": "ignoreAllDefaultArgs", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`.↵Dangerous option; use with care. Defaults to `false`." + } + ], + "required": false, + "comment": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. Dangerous\noption; use with care. Defaults to `false`.", + "async": false, + "alias": "ignoreAllDefaultArgs", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "ignoreDefaultArgs", + "type": { + "name": "", + "union": [ + { + "name": "boolean" + }, + { + "name": "Array", + "templates": [ + { + "name": "string" + } + ] + } + ], + "expression": "[boolean]|[Array]<[string]>" + }, + "spec": [ + { + "type": "text", + "text": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. If an↵array is given, then filters out the given default arguments. Dangerous option; use with care. Defaults to `false`." + } + ], + "required": false, + "comment": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. If an array is\ngiven, then filters out the given default arguments. Dangerous option; use with care. Defaults to `false`.", + "async": false, + "alias": "ignoreDefaultArgs", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "ignoreDefaultArgs", + "type": { + "name": "Array", + "templates": [ + { + "name": "string" + } + ], + "expression": "[Array]<[string]>" + }, + "spec": [ + { + "type": "text", + "text": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`.↵Dangerous option; use with care." + } + ], + "required": false, + "comment": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. Dangerous\noption; use with care.", + "async": false, + "alias": "ignoreDefaultArgs", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "logger", + "type": { + "name": "Logger", + "expression": "[Logger]" + }, + "spec": [ + { + "type": "text", + "text": "Logger sink for Playwright logging." + } + ], + "required": false, + "comment": "Logger sink for Playwright logging.", + "async": false, + "alias": "logger", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "proxy", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "server", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example↵`http://myproxy.com:3128` or `socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP↵proxy." + } + ], + "required": true, + "comment": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example `http://myproxy.com:3128` or\n`socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP proxy.", + "async": false, + "alias": "server", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "bypass", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Optional comma-separated domains to bypass proxy, for example `\".com, chromium.org,↵.domain.com\"`." + } + ], + "required": false, + "comment": "Optional comma-separated domains to bypass proxy, for example `\".com, chromium.org, .domain.com\"`.", + "async": false, + "alias": "bypass", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "username", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Optional username to use if HTTP proxy requires authentication." + } + ], + "required": false, + "comment": "Optional username to use if HTTP proxy requires authentication.", + "async": false, + "alias": "username", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "password", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Optional password to use if HTTP proxy requires authentication." + } + ], + "required": false, + "comment": "Optional password to use if HTTP proxy requires authentication.", + "async": false, + "alias": "password", + "overloadIndex": 0, + "paramOrOption": null + } + ], + "expression": "[Object]" + }, + "spec": [ + { + "type": "text", + "text": "Network proxy settings." + } + ], + "required": false, + "comment": "Network proxy settings.", + "async": false, + "alias": "proxy", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "slowMo", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on." + } + ], + "required": false, + "comment": "Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going\non.", + "async": false, + "alias": "slowMo", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "timeout", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Maximum time in milliseconds to wait for the browser instance to start. Defaults to `30000` (30 seconds). Pass `0` to↵disable timeout." + } + ], + "required": false, + "comment": "Maximum time in milliseconds to wait for the browser instance to start. Defaults to `30000` (30 seconds). Pass `0`\nto disable timeout.", + "async": false, + "alias": "timeout", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "tracesDir", + "type": { + "name": "path", + "expression": "[path]" + }, + "spec": [ + { + "type": "text", + "text": "If specified, traces are saved into this directory." + } + ], + "required": false, + "comment": "If specified, traces are saved into this directory.", + "async": false, + "alias": "tracesDir", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + "required": false, + "comment": "", + "async": false, + "alias": "options", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "launchPersistentContext", + "type": { + "name": "BrowserContext", + "expression": "[BrowserContext]" + }, + "spec": [ + { + "type": "text", + "text": "Returns the persistent browser context instance." + }, + { + "type": "text", + "text": "Launches browser that uses persistent storage located at `userDataDir` and returns the only context. Closing↵this context will automatically close the browser." + } + ], + "required": true, + "comment": "Returns the persistent browser context instance.\n\nLaunches browser that uses persistent storage located at `userDataDir` and returns the only context. Closing this\ncontext will automatically close the browser.", + "async": true, + "alias": "launchPersistentContext", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "userDataDir", + "type": { + "name": "path", + "expression": "[path]" + }, + "spec": [ + { + "type": "text", + "text": "Path to a User Data Directory, which stores browser session data like cookies and local storage. More details for↵[Chromium](https://chromium.googlesource.com/chromium/src/+/master/docs/user_data_dir.md#introduction) and↵[Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Command_Line_Options#User_Profile).↵Note that Chromium's user data directory is the **parent** directory of the \"Profile Path\" seen at `chrome://version`. Pass an empty string to↵use a temporary directory instead." + } + ], + "required": true, + "comment": "Path to a User Data Directory, which stores browser session data like cookies and local storage. More details for\n[Chromium](https://chromium.googlesource.com/chromium/src/+/master/docs/user_data_dir.md#introduction) and\n[Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Command_Line_Options#User_Profile). Note that Chromium's\nuser data directory is the **parent** directory of the \"Profile Path\" seen at `chrome://version`. Pass an empty\nstring to use a temporary directory instead.", + "async": false, + "alias": "userDataDir", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "options", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "acceptDownloads", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Whether to automatically download all the attachments. Defaults to `true` where all the downloads are accepted." + } + ], + "required": false, + "comment": "Whether to automatically download all the attachments. Defaults to `true` where all the downloads are accepted.", + "async": false, + "alias": "acceptDownloads", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "args", + "type": { + "name": "Array", + "templates": [ + { + "name": "string" + } + ], + "expression": "[Array]<[string]>" + }, + "spec": [ + { + "type": "text", + "text": "Additional arguments to pass to the browser instance. The list of Chromium flags can be found↵[here](http://peter.sh/experiments/chromium-command-line-switches/)." + } + ], + "required": false, + "comment": "Additional arguments to pass to the browser instance. The list of Chromium flags can be found\n[here](http://peter.sh/experiments/chromium-command-line-switches/).", + "async": false, + "alias": "args", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "baseURL", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "When using [`method: Page.goto`], [`method: Page.route`], [`method: Page.waitForURL`], [`method: Page.waitForRequest`], or [`method: Page.waitForResponse`] it takes the base URL in consideration by using the [`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the corresponding URL. Examples:" + }, + { + "type": "li", + "text": "baseURL: `http://localhost:3000` and navigating to `/bar.html` results in `http://localhost:3000/bar.html`", + "liType": "bullet" + }, + { + "type": "li", + "text": "baseURL: `http://localhost:3000/foo/` and navigating to `./bar.html` results in `http://localhost:3000/foo/bar.html`", + "liType": "bullet" + }, + { + "type": "li", + "text": "baseURL: `http://localhost:3000/foo` (without trailing slash) and navigating to `./bar.html` results in `http://localhost:3000/bar.html`", + "liType": "bullet" + } + ], + "required": false, + "comment": "When using [`method: Page.goto`], [`method: Page.route`], [`method: Page.waitForURL`],\n[`method: Page.waitForRequest`], or [`method: Page.waitForResponse`] it takes the base URL in consideration by\nusing the [`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the\ncorresponding URL. Examples:\n- baseURL: `http://localhost:3000` and navigating to `/bar.html` results in `http://localhost:3000/bar.html`\n- baseURL: `http://localhost:3000/foo/` and navigating to `./bar.html` results in\n `http://localhost:3000/foo/bar.html`\n- baseURL: `http://localhost:3000/foo` (without trailing slash) and navigating to `./bar.html` results in\n `http://localhost:3000/bar.html`", + "async": false, + "alias": "baseURL", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "bypassCSP", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Toggles bypassing page's Content-Security-Policy." + } + ], + "required": false, + "comment": "Toggles bypassing page's Content-Security-Policy.", + "async": false, + "alias": "bypassCSP", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "channel", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Browser distribution channel. Supported values are \"chrome\", \"chrome-beta\", \"chrome-dev\", \"chrome-canary\", \"msedge\", \"msedge-beta\", \"msedge-dev\", \"msedge-canary\". Read more about using [Google Chrome and Microsoft Edge](../browsers.md#google-chrome--microsoft-edge)." + } + ], + "required": false, + "comment": "Browser distribution channel. Supported values are \"chrome\", \"chrome-beta\", \"chrome-dev\", \"chrome-canary\",\n\"msedge\", \"msedge-beta\", \"msedge-dev\", \"msedge-canary\". Read more about using\n[Google Chrome and Microsoft Edge](../browsers.md#google-chrome--microsoft-edge).", + "async": false, + "alias": "channel", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "chromiumSandbox", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Enable Chromium sandboxing. Defaults to `false`." + } + ], + "required": false, + "comment": "Enable Chromium sandboxing. Defaults to `false`.", + "async": false, + "alias": "chromiumSandbox", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "colorScheme", + "type": { + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "ColorScheme", + "union": [ + { + "name": "\"light\"" + }, + { + "name": "\"dark\"" + }, + { + "name": "\"no-preference\"" + } + ] + } + ], + "expression": "null|[ColorScheme]<\"light\"|\"dark\"|\"no-preference\">" + }, + "spec": [ + { + "type": "text", + "text": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See↵[`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to `'light'`." + } + ], + "required": false, + "comment": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to\n`'light'`.", + "async": false, + "alias": "colorScheme", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "colorScheme", + "type": { + "name": "ColorScheme", + "union": [ + { + "name": "\"light\"" + }, + { + "name": "\"dark\"" + }, + { + "name": "\"no-preference\"" + }, + { + "name": "\"null\"" + } + ], + "expression": "[ColorScheme]<\"light\"|\"dark\"|\"no-preference\"|\"null\">" + }, + "spec": [ + { + "type": "text", + "text": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See↵[`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to `'light'`." + } + ], + "required": false, + "comment": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to\n`'light'`.", + "async": false, + "alias": "colorScheme", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "deviceScaleFactor", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Specify device scale factor (can be thought of as dpr). Defaults to `1`." + } + ], + "required": false, + "comment": "Specify device scale factor (can be thought of as dpr). Defaults to `1`.", + "async": false, + "alias": "deviceScaleFactor", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "devtools", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "**Chromium-only** Whether to auto-open a Developer Tools panel for each tab. If this option is `true`, the↵`headless` option will be set `false`." + } + ], + "required": false, + "comment": "**Chromium-only** Whether to auto-open a Developer Tools panel for each tab. If this option is `true`, the\n`headless` option will be set `false`.", + "async": false, + "alias": "devtools", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "downloadsPath", + "type": { + "name": "path", + "expression": "[path]" + }, + "spec": [ + { + "type": "text", + "text": "If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is↵deleted when browser is closed. In either case, the downloads are deleted when the browser context they were created in↵is closed." + } + ], + "required": false, + "comment": "If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and\nis deleted when browser is closed. In either case, the downloads are deleted when the browser context they were\ncreated in is closed.", + "async": false, + "alias": "downloadsPath", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "env", + "type": { + "name": "Object", + "templates": [ + { + "name": "string" + }, + { + "name": "string" + } + ], + "expression": "[Object]<[string], [string]>" + }, + "spec": [ + { + "type": "text", + "text": "Specify environment variables that will be visible to the browser. Defaults to `process.env`." + } + ], + "required": false, + "comment": "Specify environment variables that will be visible to the browser. Defaults to `process.env`.", + "async": false, + "alias": "env", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "env", + "type": { + "name": "Object", + "templates": [ + { + "name": "string" + }, + { + "name": "", + "union": [ + { + "name": "string" + }, + { + "name": "float" + }, + { + "name": "boolean" + } + ] + } + ], + "expression": "[Object]<[string], [string]|[float]|[boolean]>" + }, + "spec": [ + { + "type": "text", + "text": "Specify environment variables that will be visible to the browser. Defaults to `process.env`." + } + ], + "required": false, + "comment": "Specify environment variables that will be visible to the browser. Defaults to `process.env`.", + "async": false, + "alias": "env", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "executablePath", + "type": { + "name": "path", + "expression": "[path]" + }, + "spec": [ + { + "type": "text", + "text": "Path to a browser executable to run instead of the bundled one. If `executablePath` is a relative path, then↵it is resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium,↵Firefox or WebKit, use at your own risk." + } + ], + "required": false, + "comment": "Path to a browser executable to run instead of the bundled one. If `executablePath` is a relative path, then it is\nresolved relative to the current working directory. Note that Playwright only works with the bundled Chromium,\nFirefox or WebKit, use at your own risk.", + "async": false, + "alias": "executablePath", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "extraHTTPHeaders", + "type": { + "name": "Object", + "templates": [ + { + "name": "string" + }, + { + "name": "string" + } + ], + "expression": "[Object]<[string], [string]>" + }, + "spec": [ + { + "type": "text", + "text": "An object containing additional HTTP headers to be sent with every request." + } + ], + "required": false, + "comment": "An object containing additional HTTP headers to be sent with every request.", + "async": false, + "alias": "extraHTTPHeaders", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "forcedColors", + "type": { + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "ForcedColors", + "union": [ + { + "name": "\"active\"" + }, + { + "name": "\"none\"" + } + ] + } + ], + "expression": "null|[ForcedColors]<\"active\"|\"none\">" + }, + "spec": [ + { + "type": "text", + "text": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See [`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to `'none'`." + } + ], + "required": false, + "comment": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See\n[`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to\n`'none'`.", + "async": false, + "alias": "forcedColors", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "forcedColors", + "type": { + "name": "ForcedColors", + "union": [ + { + "name": "\"active\"" + }, + { + "name": "\"none\"" + }, + { + "name": "\"null\"" + } + ], + "expression": "[ForcedColors]<\"active\"|\"none\"|\"null\">" + }, + "spec": [ + { + "type": "text", + "text": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See [`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to `'none'`." + } + ], + "required": false, + "comment": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See\n[`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to\n`'none'`.", + "async": false, + "alias": "forcedColors", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "geolocation", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "latitude", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Latitude between -90 and 90." + } + ], + "required": true, + "comment": "Latitude between -90 and 90.", + "async": false, + "alias": "latitude", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "longitude", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Longitude between -180 and 180." + } + ], + "required": true, + "comment": "Longitude between -180 and 180.", + "async": false, + "alias": "longitude", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "accuracy", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Non-negative accuracy value. Defaults to `0`." + } + ], + "required": false, + "comment": "Non-negative accuracy value. Defaults to `0`.", + "async": false, + "alias": "accuracy", + "overloadIndex": 0, + "paramOrOption": null + } + ], + "expression": "[Object]" + }, + "spec": [], + "required": false, + "comment": "", + "async": false, + "alias": "geolocation", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "handleSIGHUP", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Close the browser process on SIGHUP. Defaults to `true`." + } + ], + "required": false, + "comment": "Close the browser process on SIGHUP. Defaults to `true`.", + "async": false, + "alias": "handleSIGHUP", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "handleSIGINT", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Close the browser process on Ctrl-C. Defaults to `true`." + } + ], + "required": false, + "comment": "Close the browser process on Ctrl-C. Defaults to `true`.", + "async": false, + "alias": "handleSIGINT", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "handleSIGTERM", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Close the browser process on SIGTERM. Defaults to `true`." + } + ], + "required": false, + "comment": "Close the browser process on SIGTERM. Defaults to `true`.", + "async": false, + "alias": "handleSIGTERM", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "hasTouch", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Specifies if viewport supports touch events. Defaults to false." + } + ], + "required": false, + "comment": "Specifies if viewport supports touch events. Defaults to false.", + "async": false, + "alias": "hasTouch", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "headless", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Whether to run browser in headless mode. More details for↵[Chromium](https://developers.google.com/web/updates/2017/04/headless-chrome) and↵[Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Firefox/Headless_mode). Defaults to `true` unless the↵`devtools` option is `true`." + } + ], + "required": false, + "comment": "Whether to run browser in headless mode. More details for\n[Chromium](https://developers.google.com/web/updates/2017/04/headless-chrome) and\n[Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Firefox/Headless_mode). Defaults to `true` unless the\n`devtools` option is `true`.", + "async": false, + "alias": "headless", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "httpCredentials", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "username", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "username", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "password", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "password", + "overloadIndex": 0, + "paramOrOption": null + } + ], + "expression": "[Object]" + }, + "spec": [ + { + "type": "text", + "text": "Credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)." + } + ], + "required": false, + "comment": "Credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication).", + "async": false, + "alias": "httpCredentials", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.9", + "name": "ignoreAllDefaultArgs", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`.↵Dangerous option; use with care. Defaults to `false`." + } + ], + "required": false, + "comment": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. Dangerous\noption; use with care. Defaults to `false`.", + "async": false, + "alias": "ignoreAllDefaultArgs", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "ignoreDefaultArgs", + "type": { + "name": "", + "union": [ + { + "name": "boolean" + }, + { + "name": "Array", + "templates": [ + { + "name": "string" + } + ] + } + ], + "expression": "[boolean]|[Array]<[string]>" + }, + "spec": [ + { + "type": "text", + "text": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. If an↵array is given, then filters out the given default arguments. Dangerous option; use with care. Defaults to `false`." + } + ], + "required": false, + "comment": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. If an array is\ngiven, then filters out the given default arguments. Dangerous option; use with care. Defaults to `false`.", + "async": false, + "alias": "ignoreDefaultArgs", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "ignoreDefaultArgs", + "type": { + "name": "Array", + "templates": [ + { + "name": "string" + } + ], + "expression": "[Array]<[string]>" + }, + "spec": [ + { + "type": "text", + "text": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`.↵Dangerous option; use with care." + } + ], + "required": false, + "comment": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. Dangerous\noption; use with care.", + "async": false, + "alias": "ignoreDefaultArgs", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "ignoreHTTPSErrors", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`." + } + ], + "required": false, + "comment": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.", + "async": false, + "alias": "ignoreHTTPSErrors", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "isMobile", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Whether the `meta viewport` tag is taken into account and touch events are enabled. Defaults to `false`. Not supported↵in Firefox." + } + ], + "required": false, + "comment": "Whether the `meta viewport` tag is taken into account and touch events are enabled. Defaults to `false`. Not\nsupported in Firefox.", + "async": false, + "alias": "isMobile", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "javaScriptEnabled", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Whether or not to enable JavaScript in the context. Defaults to `true`." + } + ], + "required": false, + "comment": "Whether or not to enable JavaScript in the context. Defaults to `true`.", + "async": false, + "alias": "javaScriptEnabled", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "locale", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value, `Accept-Language`↵request header value as well as number and date formatting rules." + } + ], + "required": false, + "comment": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value,\n`Accept-Language` request header value as well as number and date formatting rules.", + "async": false, + "alias": "locale", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "logger", + "type": { + "name": "Logger", + "expression": "[Logger]" + }, + "spec": [ + { + "type": "text", + "text": "Logger sink for Playwright logging." + } + ], + "required": false, + "comment": "Logger sink for Playwright logging.", + "async": false, + "alias": "logger", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "noViewport", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Does not enforce fixed viewport, allows resizing window in the headed mode." + } + ], + "required": false, + "comment": "Does not enforce fixed viewport, allows resizing window in the headed mode.", + "async": false, + "alias": "noViewport", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "offline", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Whether to emulate network being offline. Defaults to `false`." + } + ], + "required": false, + "comment": "Whether to emulate network being offline. Defaults to `false`.", + "async": false, + "alias": "offline", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "permissions", + "type": { + "name": "Array", + "templates": [ + { + "name": "string" + } + ], + "expression": "[Array]<[string]>" + }, + "spec": [ + { + "type": "text", + "text": "A list of permissions to grant to all pages in this context. See↵[`method: BrowserContext.grantPermissions`] for more details." + } + ], + "required": false, + "comment": "A list of permissions to grant to all pages in this context. See [`method: BrowserContext.grantPermissions`] for\nmore details.", + "async": false, + "alias": "permissions", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "proxy", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "server", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example↵`http://myproxy.com:3128` or `socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP↵proxy." + } + ], + "required": true, + "comment": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example `http://myproxy.com:3128` or\n`socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP proxy.", + "async": false, + "alias": "server", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "bypass", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Optional comma-separated domains to bypass proxy, for example `\".com, chromium.org,↵.domain.com\"`." + } + ], + "required": false, + "comment": "Optional comma-separated domains to bypass proxy, for example `\".com, chromium.org, .domain.com\"`.", + "async": false, + "alias": "bypass", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "username", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Optional username to use if HTTP proxy requires authentication." + } + ], + "required": false, + "comment": "Optional username to use if HTTP proxy requires authentication.", + "async": false, + "alias": "username", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "password", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Optional password to use if HTTP proxy requires authentication." + } + ], + "required": false, + "comment": "Optional password to use if HTTP proxy requires authentication.", + "async": false, + "alias": "password", + "overloadIndex": 0, + "paramOrOption": null + } + ], + "expression": "[Object]" + }, + "spec": [ + { + "type": "text", + "text": "Network proxy settings." + } + ], + "required": false, + "comment": "Network proxy settings.", + "async": false, + "alias": "proxy", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "recordHar", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "omitContent", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Optional setting to control whether to omit request content from the HAR. Defaults to↵`false`. Deprecated, use `content` policy instead." + } + ], + "required": false, + "comment": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`. Deprecated, use\n`content` policy instead.", + "async": false, + "alias": "omitContent", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "content", + "type": { + "name": "HarContentPolicy", + "union": [ + { + "name": "\"omit\"" + }, + { + "name": "\"embed\"" + }, + { + "name": "\"attach\"" + } + ], + "expression": "[HarContentPolicy]<\"omit\"|\"embed\"|\"attach\">" + }, + "spec": [ + { + "type": "text", + "text": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach` is specified, resources are persisted as separate files or entries in the ZIP archive. If `embed` is specified, content is stored inline the HAR file as per HAR specification. Defaults to `attach` for `.zip` output files and to `embed` for all other file extensions." + } + ], + "required": false, + "comment": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If\n`attach` is specified, resources are persisted as separate files or entries in the ZIP archive. If `embed` is\nspecified, content is stored inline the HAR file as per HAR specification. Defaults to `attach` for `.zip` output\nfiles and to `embed` for all other file extensions.", + "async": false, + "alias": "content", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "path", + "type": { + "name": "path", + "expression": "[path]" + }, + "spec": [ + { + "type": "text", + "text": "Path on the filesystem to write the HAR file to. If the file name ends with `.zip`, `content: 'attach'` is used by default." + } + ], + "required": true, + "comment": "Path on the filesystem to write the HAR file to. If the file name ends with `.zip`, `content: 'attach'` is used by\ndefault.", + "async": false, + "alias": "path", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "mode", + "type": { + "name": "HarMode", + "union": [ + { + "name": "\"full\"" + }, + { + "name": "\"minimal\"" + } + ], + "expression": "[HarMode]<\"full\"|\"minimal\">" + }, + "spec": [ + { + "type": "text", + "text": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to `full`." + } + ], + "required": false, + "comment": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page,\ncookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.", + "async": false, + "alias": "mode", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "urlFilter", + "type": { + "name": "", + "union": [ + { + "name": "string" + }, + { + "name": "RegExp" + } + ], + "expression": "[string]|[RegExp]" + }, + "spec": [ + { + "type": "text", + "text": "A glob or regex pattern to filter requests that are stored in the HAR. When a `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." + } + ], + "required": false, + "comment": "A glob or regex pattern to filter requests that are stored in the HAR. When a `baseURL` via the context options was\nprovided and the passed URL is a path, it gets merged via the\n[`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor.", + "async": false, + "alias": "urlFilter", + "overloadIndex": 0, + "paramOrOption": null + } + ], + "expression": "[Object]" + }, + "spec": [ + { + "type": "text", + "text": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into `recordHar.path` file. If not↵specified, the HAR is not recorded. Make sure to await [`method: BrowserContext.close`] for the HAR to be↵saved." + } + ], + "required": false, + "comment": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into `recordHar.path` file.\nIf not specified, the HAR is not recorded. Make sure to await [`method: BrowserContext.close`] for the HAR to be\nsaved.", + "async": false, + "alias": "recordHar", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "java", + "python" + ], + "aliases": { + "python": "record_har_content" + }, + "types": {}, + "overrides": {} + }, "experimental": false, - "since": "v1.0", - "name": "name", + "since": "v1.8", + "name": "recordHarContent", "type": { - "name": "string", - "expression": "[string]" + "name": "HarContentPolicy", + "union": [ + { + "name": "\"omit\"" + }, + { + "name": "\"embed\"" + }, + { + "name": "\"attach\"" + } + ], + "expression": "[HarContentPolicy]<\"omit\"|\"embed\"|\"attach\">" }, "spec": [ { "type": "text", - "text": "" + "text": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach` is specified, resources are persisted as separate files and all of these files are archived along with the HAR file. Defaults to `embed`, which stores content inline the HAR file as per HAR specification." } ], - "required": true, - "comment": "", - "deprecated": false, + "required": false, + "comment": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If\n`attach` is specified, resources are persisted as separate files and all of these files are archived along with the\nHAR file. Defaults to `embed`, which stores content inline the HAR file as per HAR specification.", "async": false, - "alias": "name", + "alias": "recordHarContent", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "csharp", + "java", + "python" + ], + "aliases": { + "python": "record_har_mode" + }, + "types": {}, + "overrides": {} + }, "experimental": false, - "since": "v1.0", - "name": "value", + "since": "v1.8", + "name": "recordHarMode", "type": { - "name": "string", - "expression": "[string]" + "name": "HarMode", + "union": [ + { + "name": "\"full\"" + }, + { + "name": "\"minimal\"" + } + ], + "expression": "[HarMode]<\"full\"|\"minimal\">" }, "spec": [ { "type": "text", - "text": "" + "text": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to `full`." } ], - "required": true, - "comment": "", - "deprecated": false, + "required": false, + "comment": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page,\ncookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.", "async": false, - "alias": "value", + "alias": "recordHarMode", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "csharp", + "java", + "python" + ], + "aliases": { + "python": "record_har_omit_content" + }, + "types": {}, + "overrides": {} + }, "experimental": false, - "since": "v1.0", - "name": "domain", + "since": "v1.8", + "name": "recordHarOmitContent", "type": { - "name": "string", - "expression": "[string]" + "name": "boolean", + "expression": "[boolean]" }, "spec": [ { "type": "text", - "text": "" + "text": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`." } ], - "required": true, - "comment": "", - "deprecated": false, + "required": false, + "comment": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`.", "async": false, - "alias": "domain", + "alias": "recordHarOmitContent", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "csharp", + "java", + "python" + ], + "aliases": { + "python": "record_har_path" + }, + "types": {}, + "overrides": {} + }, "experimental": false, - "since": "v1.0", - "name": "path", + "since": "v1.8", + "name": "recordHarPath", "type": { - "name": "string", - "expression": "[string]" + "name": "path", + "expression": "[path]" }, "spec": [ { "type": "text", - "text": "" + "text": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the↵specified HAR file on the filesystem. If not specified, the HAR is not recorded. Make sure to↵call [`method: BrowserContext.close`] for the HAR to be saved." } ], - "required": true, + "required": false, + "comment": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the specified HAR file\non the filesystem. If not specified, the HAR is not recorded. Make sure to call [`method: BrowserContext.close`]\nfor the HAR to be saved.", + "async": false, + "alias": "recordHarPath", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "java", + "python" + ], + "aliases": { + "python": "record_har_url_filter" + }, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "recordHarUrlFilter", + "type": { + "name": "", + "union": [ + { + "name": "string" + }, + { + "name": "RegExp" + } + ], + "expression": "[string]|[RegExp]" + }, + "spec": [], + "required": false, "comment": "", - "deprecated": false, "async": false, - "alias": "path", + "alias": "recordHarUrlFilter", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, - "since": "v1.0", - "name": "expires", + "since": "v1.8", + "name": "recordVideo", "type": { - "name": "float", - "expression": "[float]" + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "dir", + "type": { + "name": "path", + "expression": "[path]" + }, + "spec": [ + { + "type": "text", + "text": "Path to the directory to put videos into." + } + ], + "required": true, + "comment": "Path to the directory to put videos into.", + "async": false, + "alias": "dir", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "size", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "width", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "Video frame width." + } + ], + "required": true, + "comment": "Video frame width.", + "async": false, + "alias": "width", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "height", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "Video frame height." + } + ], + "required": true, + "comment": "Video frame height.", + "async": false, + "alias": "height", + "overloadIndex": 0, + "paramOrOption": null + } + ], + "expression": "[Object]" + }, + "spec": [ + { + "type": "text", + "text": "Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport`↵scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450.↵Actual picture of each page will be scaled down if necessary to fit the specified size." + } + ], + "required": false, + "comment": "Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to\nfit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of\neach page will be scaled down if necessary to fit the specified size.", + "async": false, + "alias": "size", + "overloadIndex": 0, + "paramOrOption": null + } + ], + "expression": "[Object]" }, "spec": [ { "type": "text", - "text": "Unix time in seconds." + "text": "Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make↵sure to await [`method: BrowserContext.close`] for videos to be saved." } ], - "required": true, - "comment": "Unix time in seconds.", - "deprecated": false, + "required": false, + "comment": "Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded.\nMake sure to await [`method: BrowserContext.close`] for videos to be saved.", "async": false, - "alias": "expires", + "alias": "recordVideo", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "csharp", + "java", + "python" + ], + "aliases": { + "python": "record_video_dir" + }, + "types": {}, + "overrides": {} + }, "experimental": false, - "since": "v1.0", - "name": "httpOnly", + "since": "v1.8", + "name": "recordVideoDir", "type": { - "name": "boolean", - "expression": "[boolean]" + "name": "path", + "expression": "[path]" + }, + "spec": [ + { + "type": "text", + "text": "Enables video recording for all pages into the specified directory. If not specified videos are↵not recorded. Make sure to call [`method: BrowserContext.close`] for videos to be saved." + } + ], + "required": false, + "comment": "Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make\nsure to call [`method: BrowserContext.close`] for videos to be saved.", + "async": false, + "alias": "recordVideoDir", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "java", + "python" + ], + "aliases": { + "python": "record_video_size" + }, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "recordVideoSize", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "width", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "Video frame width." + } + ], + "required": true, + "comment": "Video frame width.", + "async": false, + "alias": "width", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "height", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "Video frame height." + } + ], + "required": true, + "comment": "Video frame height.", + "async": false, + "alias": "height", + "overloadIndex": 0, + "paramOrOption": null + } + ], + "expression": "[Object]" }, "spec": [ { "type": "text", - "text": "" + "text": "Dimensions of the recorded videos. If not specified the size will be equal to `viewport`↵scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450.↵Actual picture of each page will be scaled down if necessary to fit the specified size." } ], - "required": true, - "comment": "", - "deprecated": false, + "required": false, + "comment": "Dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit into\n800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page\nwill be scaled down if necessary to fit the specified size.", "async": false, - "alias": "httpOnly", + "alias": "recordVideoSize", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "js", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, - "since": "v1.0", - "name": "secure", + "since": "v1.8", + "name": "reducedMotion", "type": { - "name": "boolean", - "expression": "[boolean]" + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "ReducedMotion", + "union": [ + { + "name": "\"reduce\"" + }, + { + "name": "\"no-preference\"" + } + ] + } + ], + "expression": "null|[ReducedMotion]<\"reduce\"|\"no-preference\">" }, "spec": [ { "type": "text", - "text": "" + "text": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See [`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to `'no-preference'`." } ], - "required": true, - "comment": "", - "deprecated": false, + "required": false, + "comment": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to\n`'no-preference'`.", "async": false, - "alias": "secure", + "alias": "reducedMotion", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "csharp", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, - "since": "v1.0", - "name": "sameSite", + "since": "v1.8", + "name": "reducedMotion", "type": { - "name": "SameSiteAttribute", + "name": "ReducedMotion", "union": [ { - "name": "\"Strict\"" + "name": "\"reduce\"" }, { - "name": "\"Lax\"" + "name": "\"no-preference\"" }, { - "name": "\"None\"" + "name": "\"null\"" } ], - "expression": "[SameSiteAttribute]<\"Strict\"|\"Lax\"|\"None\">" + "expression": "[ReducedMotion]<\"reduce\"|\"no-preference\"|\"null\">" }, "spec": [ { "type": "text", - "text": "" + "text": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See [`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to `'no-preference'`." } ], - "required": true, - "comment": "", - "deprecated": false, + "required": false, + "comment": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to\n`'no-preference'`.", "async": false, - "alias": "sameSite", + "alias": "reducedMotion", "overloadIndex": 0, "paramOrOption": null - } - ] - } - ], - "expression": "[Array]<[Object]>" - }, - "spec": [ - { - "type": "text", - "text": "If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those URLs are returned." - } - ], - "required": true, - "comment": "If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those URLs\nare returned.", - "deprecated": false, - "async": true, - "alias": "cookies", - "overloadIndex": 0, - "paramOrOption": null, - "args": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "urls", - "type": { - "name": "", - "union": [ - { - "name": "string" }, { - "name": "Array", - "templates": [ - { - "name": "string" - } - ] - } - ], - "expression": "[string]|[Array]<[string]>" - }, - "spec": [ - { - "type": "text", - "text": "Optional list of URLs." - } - ], - "required": false, - "comment": "Optional list of URLs.", - "deprecated": false, - "async": false, - "alias": "urls", - "overloadIndex": 0, - "paramOrOption": null - } - ] - }, - { - "kind": "method", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "exposeBinding", - "type": { - "name": "void" - }, - "spec": [ - { - "type": "text", - "text": "The method adds a function called `name` on the `window` object of every frame in every page in the context. When called, the function executes `callback` and returns a [Promise] which resolves to the return value of `callback`. If the `callback` returns a [Promise], it will be awaited." - }, - { - "type": "text", - "text": "The first argument of the `callback` function contains information about the caller: `{ browserContext: BrowserContext, page: Page, frame: Frame }`." - }, - { - "type": "text", - "text": "See [`method: Page.exposeBinding`] for page-only version." - }, - { - "type": "text", - "text": "An example of exposing page URL to all frames in all pages in the context:" - }, - { - "type": "code", - "lines": [ - "const { webkit } = require('playwright'); // Or 'chromium' or 'firefox'.", - "", - "(async () => {", - " const browser = await webkit.launch({ headless: false });", - " const context = await browser.newContext();", - " await context.exposeBinding('pageURL', ({ page }) => page.url());", - " const page = await context.newPage();", - " await page.setContent(`", - " ", - " ", - "
", - " `);", - " await page.locator('button').click();", - "})();" - ], - "codeLang": "js" - }, - { - "type": "code", - "lines": [ - "import com.microsoft.playwright.*;", - "", - "public class Example {", - " public static void main(String[] args) {", - " try (Playwright playwright = Playwright.create()) {", - " BrowserType webkit = playwright.webkit()", - " Browser browser = webkit.launch(new BrowserType.LaunchOptions().setHeadless(false));", - " BrowserContext context = browser.newContext();", - " context.exposeBinding(\"pageURL\", (source, args) -> source.page().url());", - " Page page = context.newPage();", - " page.setContent(\"\\n\" +", - " \"\\n\" +", - " \"
\");", - " page.locator(\"button\").click();", - " }", - " }", - "}" - ], - "codeLang": "java" - }, - { - "type": "code", - "lines": [ - "import asyncio", - "from playwright.async_api import async_playwright", - "", - "async def run(playwright):", - " webkit = playwright.webkit", - " browser = await webkit.launch(headless=false)", - " context = await browser.new_context()", - " await context.expose_binding(\"pageURL\", lambda source: source[\"page\"].url)", - " page = await context.new_page()", - " await page.set_content(\"\"\"", - " ", - " ", - "
", - " \"\"\")", - " await page.locator(\"button\").click()", - "", - "async def main():", - " async with async_playwright() as playwright:", - " await run(playwright)", - "asyncio.run(main())" - ], - "codeLang": "python async" - }, - { - "type": "code", - "lines": [ - "from playwright.sync_api import sync_playwright", - "", - "def run(playwright):", - " webkit = playwright.webkit", - " browser = webkit.launch(headless=false)", - " context = browser.new_context()", - " context.expose_binding(\"pageURL\", lambda source: source[\"page\"].url)", - " page = context.new_page()", - " page.set_content(\"\"\"", - " ", - " ", - "
", - " \"\"\")", - " page.locator(\"button\").click()", - "", - "with sync_playwright() as playwright:", - " run(playwright)" - ], - "codeLang": "python sync" - }, - { - "type": "code", - "lines": [ - "using Microsoft.Playwright;", - "", - "using var playwright = await Playwright.CreateAsync();", - "var browser = await playwright.Webkit.LaunchAsync(new BrowserTypeLaunchOptions { Headless = false });", - "var context = await browser.NewContextAsync();", - "", - "await context.ExposeBindingAsync(\"pageURL\", source => source.Page.Url);", - "var page = await context.NewPageAsync();", - "await page.SetContentAsync(\"\\n\" +", - "\"\\n\" +", - "\"
\");", - "await page.Locator(\"button\").ClickAsync();" - ], - "codeLang": "csharp" - }, - { - "type": "text", - "text": "An example of passing an element handle:" - }, - { - "type": "code", - "lines": [ - "await context.exposeBinding('clicked', async (source, element) => {", - " console.log(await element.textContent());", - "}, { handle: true });", - "await page.setContent(`", - " ", - "
Click me
", - "
Or click me
", - "`);" - ], - "codeLang": "js" - }, - { - "type": "code", - "lines": [ - "context.exposeBinding(\"clicked\", (source, args) -> {", - " ElementHandle element = (ElementHandle) args[0];", - " System.out.println(element.textContent());", - " return null;", - "}, new BrowserContext.ExposeBindingOptions().setHandle(true));", - "page.setContent(\"\" +", - " \"\\n\" +", - " \"
Click me
\\n\" +", - " \"
Or click me
\\n\");" - ], - "codeLang": "java" - }, - { - "type": "code", - "lines": [ - "async def print(source, element):", - " print(await element.text_content())", - "", - "await context.expose_binding(\"clicked\", print, handle=true)", - "await page.set_content(\"\"\"", - " ", - "
Click me
", - "
Or click me
", - "\"\"\")" - ], - "codeLang": "python async" - }, - { - "type": "code", - "lines": [ - "def print(source, element):", - " print(element.text_content())", - "", - "context.expose_binding(\"clicked\", print, handle=true)", - "page.set_content(\"\"\"", - " ", - "
Click me
", - "
Or click me
", - "\"\"\")" - ], - "codeLang": "python sync" - }, - { - "type": "code", - "lines": [ - "var result = new TaskCompletionSource();", - "var page = await Context.NewPageAsync();", - "await Context.ExposeBindingAsync(\"clicked\", async (BindingSource _, IJSHandle t) =>", - "{", - " return result.TrySetResult(await t.AsElement().TextContentAsync());", - "});", - "", - "await page.SetContentAsync(\"\\n\" +", - " \"
Click me
\\n\" +", - " \"
Or click me
\\n\");", - "", - "await page.ClickAsync(\"div\");", - "// Note: it makes sense to await the result here, because otherwise, the context", - "// gets closed and the binding function will throw an exception.", - "Assert.AreEqual(\"Click me\", await result.Task);" - ], - "codeLang": "csharp" - } - ], - "required": true, - "comment": "The method adds a function called `name` on the `window` object of every frame in every page in the context. When\ncalled, the function executes `callback` and returns a [Promise] which resolves to the return value of `callback`. If\nthe `callback` returns a [Promise], it will be awaited.\n\nThe first argument of the `callback` function contains information about the caller: `{ browserContext: BrowserContext,\npage: Page, frame: Frame }`.\n\nSee [`method: Page.exposeBinding`] for page-only version.\n\nAn example of exposing page URL to all frames in all pages in the context:\n\n```js\nconst { webkit } = require('playwright'); // Or 'chromium' or 'firefox'.\n\n(async () => {\n const browser = await webkit.launch({ headless: false });\n const context = await browser.newContext();\n await context.exposeBinding('pageURL', ({ page }) => page.url());\n const page = await context.newPage();\n await page.setContent(`\n \n \n
\n `);\n await page.locator('button').click();\n})();\n```\n\n```java\nimport com.microsoft.playwright.*;\n\npublic class Example {\n public static void main(String[] args) {\n try (Playwright playwright = Playwright.create()) {\n BrowserType webkit = playwright.webkit()\n Browser browser = webkit.launch(new BrowserType.LaunchOptions().setHeadless(false));\n BrowserContext context = browser.newContext();\n context.exposeBinding(\"pageURL\", (source, args) -> source.page().url());\n Page page = context.newPage();\n page.setContent(\"\\n\" +\n \"\\n\" +\n \"
\");\n page.locator(\"button\").click();\n }\n }\n}\n```\n\n```python async\nimport asyncio\nfrom playwright.async_api import async_playwright\n\nasync def run(playwright):\n webkit = playwright.webkit\n browser = await webkit.launch(headless=false)\n context = await browser.new_context()\n await context.expose_binding(\"pageURL\", lambda source: source[\"page\"].url)\n page = await context.new_page()\n await page.set_content(\"\"\"\n \n \n
\n \"\"\")\n await page.locator(\"button\").click()\n\nasync def main():\n async with async_playwright() as playwright:\n await run(playwright)\nasyncio.run(main())\n```\n\n```python sync\nfrom playwright.sync_api import sync_playwright\n\ndef run(playwright):\n webkit = playwright.webkit\n browser = webkit.launch(headless=false)\n context = browser.new_context()\n context.expose_binding(\"pageURL\", lambda source: source[\"page\"].url)\n page = context.new_page()\n page.set_content(\"\"\"\n \n \n
\n \"\"\")\n page.locator(\"button\").click()\n\nwith sync_playwright() as playwright:\n run(playwright)\n```\n\n```csharp\nusing Microsoft.Playwright;\n\nusing var playwright = await Playwright.CreateAsync();\nvar browser = await playwright.Webkit.LaunchAsync(new BrowserTypeLaunchOptions { Headless = false });\nvar context = await browser.NewContextAsync();\n\nawait context.ExposeBindingAsync(\"pageURL\", source => source.Page.Url);\nvar page = await context.NewPageAsync();\nawait page.SetContentAsync(\"\\n\" +\n\"\\n\" +\n\"
\");\nawait page.Locator(\"button\").ClickAsync();\n```\n\nAn example of passing an element handle:\n\n```js\nawait context.exposeBinding('clicked', async (source, element) => {\n console.log(await element.textContent());\n}, { handle: true });\nawait page.setContent(`\n \n
Click me
\n
Or click me
\n`);\n```\n\n```java\ncontext.exposeBinding(\"clicked\", (source, args) -> {\n ElementHandle element = (ElementHandle) args[0];\n System.out.println(element.textContent());\n return null;\n}, new BrowserContext.ExposeBindingOptions().setHandle(true));\npage.setContent(\"\" +\n \"\\n\" +\n \"
Click me
\\n\" +\n \"
Or click me
\\n\");\n```\n\n```python async\nasync def print(source, element):\n print(await element.text_content())\n\nawait context.expose_binding(\"clicked\", print, handle=true)\nawait page.set_content(\"\"\"\n \n
Click me
\n
Or click me
\n\"\"\")\n```\n\n```python sync\ndef print(source, element):\n print(element.text_content())\n\ncontext.expose_binding(\"clicked\", print, handle=true)\npage.set_content(\"\"\"\n \n
Click me
\n
Or click me
\n\"\"\")\n```\n\n```csharp\nvar result = new TaskCompletionSource();\nvar page = await Context.NewPageAsync();\nawait Context.ExposeBindingAsync(\"clicked\", async (BindingSource _, IJSHandle t) =>\n{\n return result.TrySetResult(await t.AsElement().TextContentAsync());\n});\n\nawait page.SetContentAsync(\"\\n\" +\n \"
Click me
\\n\" +\n \"
Or click me
\\n\");\n\nawait page.ClickAsync(\"div\");\n// Note: it makes sense to await the result here, because otherwise, the context\n// gets closed and the binding function will throw an exception.\nAssert.AreEqual(\"Click me\", await result.Task);\n```\n", - "deprecated": false, - "async": true, - "alias": "exposeBinding", - "overloadIndex": 0, - "paramOrOption": null, - "args": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "name", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "Name of the function on the window object." - } - ], - "required": true, - "comment": "Name of the function on the window object.", - "deprecated": false, - "async": false, - "alias": "name", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "callback", - "type": { - "name": "function", - "expression": "[function]" - }, - "spec": [ - { - "type": "text", - "text": "Callback function that will be called in the Playwright's context." - } - ], - "required": true, - "comment": "Callback function that will be called in the Playwright's context.", - "deprecated": false, - "async": false, - "alias": "callback", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "options", - "type": { - "name": "Object", - "properties": [ + "kind": "property", + "langs": { + "aliases": { + "java": "screenSize", + "csharp": "screenSize" + }, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "screen", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "width", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "page width in pixels." + } + ], + "required": true, + "comment": "page width in pixels.", + "async": false, + "alias": "width", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "height", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "page height in pixels." + } + ], + "required": true, + "comment": "page height in pixels.", + "async": false, + "alias": "height", + "overloadIndex": 0, + "paramOrOption": null + } + ], + "expression": "[Object]" + }, + "spec": [ + { + "type": "text", + "text": "Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the↵`viewport` is set." + } + ], + "required": false, + "comment": "Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the\n`viewport` is set.", + "async": false, + "alias": "screen", + "overloadIndex": 0, + "paramOrOption": null + }, { "kind": "property", "langs": {}, "experimental": false, "since": "v1.8", - "name": "handle", + "name": "serviceWorkers", + "type": { + "name": "ServiceWorkerPolicy", + "union": [ + { + "name": "\"allow\"" + }, + { + "name": "\"block\"" + } + ], + "expression": "[ServiceWorkerPolicy]<\"allow\"|\"block\">" + }, + "spec": [ + { + "type": "text", + "text": "Whether to allow sites to register Service workers. Defaults to `'allow'`." + }, + { + "type": "li", + "text": "`'allow'`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be registered.", + "liType": "bullet" + }, + { + "type": "li", + "text": "`'block'`: Playwright will block all registration of Service Workers.", + "liType": "bullet" + } + ], + "required": false, + "comment": "Whether to allow sites to register Service workers. Defaults to `'allow'`.\n- `'allow'`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be\n registered.\n- `'block'`: Playwright will block all registration of Service Workers.", + "async": false, + "alias": "serviceWorkers", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "slowMo", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on." + } + ], + "required": false, + "comment": "Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going\non.", + "async": false, + "alias": "slowMo", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "strictSelectors", "type": { "name": "boolean", "expression": "[boolean]" @@ -20542,431 +29157,91 @@ "spec": [ { "type": "text", - "text": "Whether to pass the argument as a handle, instead of passing by value. When passing a handle, only one argument is supported. When passing by value, multiple arguments are supported." + "text": "If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations↵on selectors that imply single target DOM element will throw when more than one element matches the selector.↵This option does not affect any Locator APIs (Locators are always strict).↵See `Locator` to learn more about the strict mode." } ], "required": false, - "comment": "Whether to pass the argument as a handle, instead of passing by value. When passing a handle, only one argument is\nsupported. When passing by value, multiple arguments are supported.", - "deprecated": false, + "comment": "If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations on\nselectors that imply single target DOM element will throw when more than one element matches the selector. This\noption does not affect any Locator APIs (Locators are always strict). See `Locator` to learn more about the strict\nmode.", "async": false, - "alias": "handle", + "alias": "strictSelectors", "overloadIndex": 0, "paramOrOption": null - } - ] - }, - "required": false, - "comment": "", - "deprecated": false, - "async": false, - "alias": "options", - "overloadIndex": 0, - "paramOrOption": null - } - ] - }, - { - "kind": "method", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "exposeFunction", - "type": { - "name": "void" - }, - "spec": [ - { - "type": "text", - "text": "The method adds a function called `name` on the `window` object of every frame in every page in the context. When called, the function executes `callback` and returns a [Promise] which resolves to the return value of `callback`." - }, - { - "type": "text", - "text": "If the `callback` returns a [Promise], it will be awaited." - }, - { - "type": "text", - "text": "See [`method: Page.exposeFunction`] for page-only version." - }, - { - "type": "text", - "text": "An example of adding a `sha256` function to all pages in the context:" - }, - { - "type": "code", - "lines": [ - "const { webkit } = require('playwright'); // Or 'chromium' or 'firefox'.", - "const crypto = require('crypto');", - "", - "(async () => {", - " const browser = await webkit.launch({ headless: false });", - " const context = await browser.newContext();", - " await context.exposeFunction('sha256', text => crypto.createHash('sha256').update(text).digest('hex'));", - " const page = await context.newPage();", - " await page.setContent(`", - " ", - " ", - "
", - " `);", - " await page.locator('button').click();", - "})();" - ], - "codeLang": "js" - }, - { - "type": "code", - "lines": [ - "import com.microsoft.playwright.*;", - "", - "import java.nio.charset.StandardCharsets;", - "import java.security.MessageDigest;", - "import java.security.NoSuchAlgorithmException;", - "import java.util.Base64;", - "", - "public class Example {", - " public static void main(String[] args) {", - " try (Playwright playwright = Playwright.create()) {", - " BrowserType webkit = playwright.webkit()", - " Browser browser = webkit.launch(new BrowserType.LaunchOptions().setHeadless(false));", - " context.exposeFunction(\"sha256\", args -> {", - " String text = (String) args[0];", - " MessageDigest crypto;", - " try {", - " crypto = MessageDigest.getInstance(\"SHA-256\");", - " } catch (NoSuchAlgorithmException e) {", - " return null;", - " }", - " byte[] token = crypto.digest(text.getBytes(StandardCharsets.UTF_8));", - " return Base64.getEncoder().encodeToString(token);", - " });", - " Page page = context.newPage();", - " page.setContent(\"\\n\" +", - " \"\\n\" +", - " \"
\\n\");", - " page.locator(\"button\").click();", - " }", - " }", - "}" - ], - "codeLang": "java" - }, - { - "type": "code", - "lines": [ - "import asyncio", - "import hashlib", - "from playwright.async_api import async_playwright", - "", - "def sha256(text):", - " m = hashlib.sha256()", - " m.update(bytes(text, \"utf8\"))", - " return m.hexdigest()", - "", - "", - "async def run(playwright):", - " webkit = playwright.webkit", - " browser = await webkit.launch(headless=False)", - " context = await browser.new_context()", - " await context.expose_function(\"sha256\", sha256)", - " page = await context.new_page()", - " await page.set_content(\"\"\"", - " ", - " ", - "
", - " \"\"\")", - " await page.locator(\"button\").click()", - "", - "async def main():", - " async with async_playwright() as playwright:", - " await run(playwright)", - "asyncio.run(main())" - ], - "codeLang": "python async" - }, - { - "type": "code", - "lines": [ - "import hashlib", - "from playwright.sync_api import sync_playwright", - "", - "def sha256(text):", - " m = hashlib.sha256()", - " m.update(bytes(text, \"utf8\"))", - " return m.hexdigest()", - "", - "", - "def run(playwright):", - " webkit = playwright.webkit", - " browser = webkit.launch(headless=False)", - " context = browser.new_context()", - " context.expose_function(\"sha256\", sha256)", - " page = context.new_page()", - " page.set_content(\"\"\"", - " ", - " ", - "
", - " \"\"\")", - " page.locator(\"button\").click()", - "", - "with sync_playwright() as playwright:", - " run(playwright)" - ], - "codeLang": "python sync" - }, - { - "type": "code", - "lines": [ - "using Microsoft.Playwright;", - "using System;", - "using System.Security.Cryptography;", - "using System.Threading.Tasks;", - "", - "class BrowserContextExamples", - "{", - " public static async Task Main()", - " {", - " using var playwright = await Playwright.CreateAsync();", - " var browser = await playwright.Webkit.LaunchAsync(new BrowserTypeLaunchOptions { Headless = false });", - " var context = await browser.NewContextAsync();", - "", - " await context.ExposeFunctionAsync(\"sha256\", (string input) =>", - " {", - " return Convert.ToBase64String(", - " SHA256.Create().ComputeHash(System.Text.Encoding.UTF8.GetBytes(input)));", - " });", - "", - " var page = await context.NewPageAsync();", - " await page.SetContentAsync(\"\\n\" +", - " \"\\n\" +", - " \"
\");", - "", - " await page.Locator(\"button\").ClickAsync();", - " Console.WriteLine(await page.TextContentAsync(\"div\"));", - " }", - "}" - ], - "codeLang": "csharp" - } - ], - "required": true, - "comment": "The method adds a function called `name` on the `window` object of every frame in every page in the context. When\ncalled, the function executes `callback` and returns a [Promise] which resolves to the return value of `callback`.\n\nIf the `callback` returns a [Promise], it will be awaited.\n\nSee [`method: Page.exposeFunction`] for page-only version.\n\nAn example of adding a `sha256` function to all pages in the context:\n\n```js\nconst { webkit } = require('playwright'); // Or 'chromium' or 'firefox'.\nconst crypto = require('crypto');\n\n(async () => {\n const browser = await webkit.launch({ headless: false });\n const context = await browser.newContext();\n await context.exposeFunction('sha256', text => crypto.createHash('sha256').update(text).digest('hex'));\n const page = await context.newPage();\n await page.setContent(`\n \n \n
\n `);\n await page.locator('button').click();\n})();\n```\n\n```java\nimport com.microsoft.playwright.*;\n\nimport java.nio.charset.StandardCharsets;\nimport java.security.MessageDigest;\nimport java.security.NoSuchAlgorithmException;\nimport java.util.Base64;\n\npublic class Example {\n public static void main(String[] args) {\n try (Playwright playwright = Playwright.create()) {\n BrowserType webkit = playwright.webkit()\n Browser browser = webkit.launch(new BrowserType.LaunchOptions().setHeadless(false));\n context.exposeFunction(\"sha256\", args -> {\n String text = (String) args[0];\n MessageDigest crypto;\n try {\n crypto = MessageDigest.getInstance(\"SHA-256\");\n } catch (NoSuchAlgorithmException e) {\n return null;\n }\n byte[] token = crypto.digest(text.getBytes(StandardCharsets.UTF_8));\n return Base64.getEncoder().encodeToString(token);\n });\n Page page = context.newPage();\n page.setContent(\"\\n\" +\n \"\\n\" +\n \"
\\n\");\n page.locator(\"button\").click();\n }\n }\n}\n```\n\n```python async\nimport asyncio\nimport hashlib\nfrom playwright.async_api import async_playwright\n\ndef sha256(text):\n m = hashlib.sha256()\n m.update(bytes(text, \"utf8\"))\n return m.hexdigest()\n\n\nasync def run(playwright):\n webkit = playwright.webkit\n browser = await webkit.launch(headless=False)\n context = await browser.new_context()\n await context.expose_function(\"sha256\", sha256)\n page = await context.new_page()\n await page.set_content(\"\"\"\n \n \n
\n \"\"\")\n await page.locator(\"button\").click()\n\nasync def main():\n async with async_playwright() as playwright:\n await run(playwright)\nasyncio.run(main())\n```\n\n```python sync\nimport hashlib\nfrom playwright.sync_api import sync_playwright\n\ndef sha256(text):\n m = hashlib.sha256()\n m.update(bytes(text, \"utf8\"))\n return m.hexdigest()\n\n\ndef run(playwright):\n webkit = playwright.webkit\n browser = webkit.launch(headless=False)\n context = browser.new_context()\n context.expose_function(\"sha256\", sha256)\n page = context.new_page()\n page.set_content(\"\"\"\n \n \n
\n \"\"\")\n page.locator(\"button\").click()\n\nwith sync_playwright() as playwright:\n run(playwright)\n```\n\n```csharp\nusing Microsoft.Playwright;\nusing System;\nusing System.Security.Cryptography;\nusing System.Threading.Tasks;\n\nclass BrowserContextExamples\n{\n public static async Task Main()\n {\n using var playwright = await Playwright.CreateAsync();\n var browser = await playwright.Webkit.LaunchAsync(new BrowserTypeLaunchOptions { Headless = false });\n var context = await browser.NewContextAsync();\n\n await context.ExposeFunctionAsync(\"sha256\", (string input) =>\n {\n return Convert.ToBase64String(\n SHA256.Create().ComputeHash(System.Text.Encoding.UTF8.GetBytes(input)));\n });\n\n var page = await context.NewPageAsync();\n await page.SetContentAsync(\"\\n\" +\n \"\\n\" +\n \"
\");\n\n await page.Locator(\"button\").ClickAsync();\n Console.WriteLine(await page.TextContentAsync(\"div\"));\n }\n}\n```\n", - "deprecated": false, - "async": true, - "alias": "exposeFunction", - "overloadIndex": 0, - "paramOrOption": null, - "args": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "name", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "Name of the function on the window object." - } - ], - "required": true, - "comment": "Name of the function on the window object.", - "deprecated": false, - "async": false, - "alias": "name", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "callback", - "type": { - "name": "function", - "expression": "[function]" - }, - "spec": [ - { - "type": "text", - "text": "Callback function that will be called in the Playwright's context." - } - ], - "required": true, - "comment": "Callback function that will be called in the Playwright's context.", - "deprecated": false, - "async": false, - "alias": "callback", - "overloadIndex": 0, - "paramOrOption": null - } - ] - }, - { - "kind": "method", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "grantPermissions", - "type": { - "name": "void" - }, - "spec": [ - { - "type": "text", - "text": "Grants specified permissions to the browser context. Only grants corresponding permissions to the given origin if specified." - } - ], - "required": true, - "comment": "Grants specified permissions to the browser context. Only grants corresponding permissions to the given origin if\nspecified.", - "deprecated": false, - "async": true, - "alias": "grantPermissions", - "overloadIndex": 0, - "paramOrOption": null, - "args": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "permissions", - "type": { - "name": "Array", - "templates": [ + }, { - "name": "string" - } - ], - "expression": "[Array]<[string]>" - }, - "spec": [ - { - "type": "text", - "text": "A permission or an array of permissions to grant. Permissions can be one of the following values:" - }, - { - "type": "li", - "text": "`'geolocation'`", - "liType": "bullet" - }, - { - "type": "li", - "text": "`'midi'`", - "liType": "bullet" - }, - { - "type": "li", - "text": "`'midi-sysex'` (system-exclusive midi)", - "liType": "bullet" - }, - { - "type": "li", - "text": "`'notifications'`", - "liType": "bullet" - }, - { - "type": "li", - "text": "`'camera'`", - "liType": "bullet" - }, - { - "type": "li", - "text": "`'microphone'`", - "liType": "bullet" - }, - { - "type": "li", - "text": "`'background-sync'`", - "liType": "bullet" - }, - { - "type": "li", - "text": "`'ambient-light-sensor'`", - "liType": "bullet" - }, - { - "type": "li", - "text": "`'accelerometer'`", - "liType": "bullet" - }, - { - "type": "li", - "text": "`'gyroscope'`", - "liType": "bullet" - }, - { - "type": "li", - "text": "`'magnetometer'`", - "liType": "bullet" - }, - { - "type": "li", - "text": "`'accessibility-events'`", - "liType": "bullet" - }, - { - "type": "li", - "text": "`'clipboard-read'`", - "liType": "bullet" - }, - { - "type": "li", - "text": "`'clipboard-write'`", - "liType": "bullet" - }, - { - "type": "li", - "text": "`'payment-handler'`", - "liType": "bullet" - } - ], - "required": true, - "comment": "A permission or an array of permissions to grant. Permissions can be one of the following values:\n- `'geolocation'`\n- `'midi'`\n- `'midi-sysex'` (system-exclusive midi)\n- `'notifications'`\n- `'camera'`\n- `'microphone'`\n- `'background-sync'`\n- `'ambient-light-sensor'`\n- `'accelerometer'`\n- `'gyroscope'`\n- `'magnetometer'`\n- `'accessibility-events'`\n- `'clipboard-read'`\n- `'clipboard-write'`\n- `'payment-handler'`", - "deprecated": false, - "async": false, - "alias": "permissions", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "options", - "type": { - "name": "Object", - "properties": [ + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "timeout", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Maximum time in milliseconds to wait for the browser instance to start. Defaults to `30000` (30 seconds). Pass `0` to↵disable timeout." + } + ], + "required": false, + "comment": "Maximum time in milliseconds to wait for the browser instance to start. Defaults to `30000` (30 seconds). Pass `0`\nto disable timeout.", + "async": false, + "alias": "timeout", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "timezoneId", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Changes the timezone of the context. See [ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1)↵for a list of supported timezone IDs." + } + ], + "required": false, + "comment": "Changes the timezone of the context. See\n[ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1)\nfor a list of supported timezone IDs.", + "async": false, + "alias": "timezoneId", + "overloadIndex": 0, + "paramOrOption": null + }, { "kind": "property", "langs": {}, "experimental": false, "since": "v1.8", - "name": "origin", + "name": "tracesDir", + "type": { + "name": "path", + "expression": "[path]" + }, + "spec": [ + { + "type": "text", + "text": "If specified, traces are saved into this directory." + } + ], + "required": false, + "comment": "If specified, traces are saved into this directory.", + "async": false, + "alias": "tracesDir", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "userAgent", "type": { "name": "string", "expression": "[string]" @@ -20974,14 +29249,386 @@ "spec": [ { "type": "text", - "text": "The [origin] to grant permissions to, e.g. \"https://example.com\"." + "text": "Specific user agent to use in this context." } ], "required": false, - "comment": "The [origin] to grant permissions to, e.g. \"https://example.com\".", - "deprecated": false, + "comment": "Specific user agent to use in this context.", "async": false, - "alias": "origin", + "alias": "userAgent", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "deprecated": "Use `recordVideo` instead.", + "name": "videoSize", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "width", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "Video frame width." + } + ], + "required": true, + "comment": "Video frame width.", + "async": false, + "alias": "width", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "height", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "Video frame height." + } + ], + "required": true, + "comment": "Video frame height.", + "async": false, + "alias": "height", + "overloadIndex": 0, + "paramOrOption": null + } + ], + "expression": "[Object]" + }, + "spec": [], + "required": false, + "comment": "", + "async": false, + "alias": "videoSize", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "deprecated": "Use `recordVideo` instead.", + "name": "videosPath", + "type": { + "name": "path", + "expression": "[path]" + }, + "spec": [], + "required": false, + "comment": "", + "async": false, + "alias": "videosPath", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "java" + ], + "aliases": { + "java": "viewportSize" + }, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "viewport", + "type": { + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "width", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "page width in pixels." + } + ], + "required": true, + "comment": "page width in pixels.", + "async": false, + "alias": "width", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "height", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "page height in pixels." + } + ], + "required": true, + "comment": "page height in pixels.", + "async": false, + "alias": "height", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ], + "expression": "[null]|[Object]" + }, + "spec": [ + { + "type": "text", + "text": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport.↵Use `null` to disable the consistent viewport emulation." + }, + { + "type": "note", + "noteType": "note", + "text": "The `null` value opts out from the default presets, makes viewport depend on the↵host window size defined by the operating system. It makes the execution of the↵tests non-deterministic." + } + ], + "required": false, + "comment": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use `null` to disable the consistent\nviewport emulation.\n\n**NOTE** The `null` value opts out from the default presets, makes viewport depend on the host window size defined\nby the operating system. It makes the execution of the tests non-deterministic.", + "async": false, + "alias": "viewport", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp" + ], + "aliases": { + "csharp": "viewportSize" + }, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "viewport", + "type": { + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "width", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "page width in pixels." + } + ], + "required": true, + "comment": "page width in pixels.", + "async": false, + "alias": "width", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "height", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "page height in pixels." + } + ], + "required": true, + "comment": "page height in pixels.", + "async": false, + "alias": "height", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ], + "expression": "[null]|[Object]" + }, + "spec": [ + { + "type": "text", + "text": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport.↵Use `ViewportSize.NoViewport` to disable the consistent viewport emulation." + }, + { + "type": "note", + "noteType": "note", + "text": "The `ViewportSize.NoViewport` value opts out from the default presets,↵makes viewport depend on the host window size defined by the operating system.↵It makes the execution of the tests non-deterministic." + } + ], + "required": false, + "comment": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use `ViewportSize.NoViewport` to\ndisable the consistent viewport emulation.\n\n**NOTE** The `ViewportSize.NoViewport` value opts out from the default presets, makes viewport depend on the host\nwindow size defined by the operating system. It makes the execution of the tests non-deterministic.", + "async": false, + "alias": "viewport", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "viewport", + "type": { + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "width", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "page width in pixels." + } + ], + "required": true, + "comment": "page width in pixels.", + "async": false, + "alias": "width", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "height", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "page height in pixels." + } + ], + "required": true, + "comment": "page height in pixels.", + "async": false, + "alias": "height", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ], + "expression": "[null]|[Object]" + }, + "spec": [ + { + "type": "text", + "text": "Sets a consistent viewport for each page. Defaults to an 1280x720 viewport. `no_viewport` disables the fixed viewport." + } + ], + "required": false, + "comment": "Sets a consistent viewport for each page. Defaults to an 1280x720 viewport. `no_viewport` disables the fixed\nviewport.", + "async": false, + "alias": "viewport", "overloadIndex": 0, "paramOrOption": null } @@ -20989,395 +29636,64 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, "paramOrOption": null } - ] - }, - { - "kind": "method", - "langs": { - "only": [ - "js", - "python" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.11", - "name": "newCDPSession", - "type": { - "name": "CDPSession", - "expression": "[CDPSession]" - }, - "spec": [ - { - "type": "note", - "noteType": "note", - "text": "CDP sessions are only supported on Chromium-based browsers." - }, - { - "type": "text", - "text": "Returns the newly created session." - } - ], - "required": true, - "comment": "> NOTE: CDP sessions are only supported on Chromium-based browsers.\n\nReturns the newly created session.", - "deprecated": false, - "async": true, - "alias": "newCDPSession", - "overloadIndex": 0, - "paramOrOption": null, - "args": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.11", - "name": "page", - "type": { - "name": "", - "union": [ - { - "name": "Page" - }, - { - "name": "Frame" - } - ], - "expression": "[Page]|[Frame]" - }, - "spec": [ - { - "type": "text", - "text": "Target to create new session for. For backwards-compatibility, this parameter is named `page`, but it can be a `Page` or `Frame` type." - } - ], - "required": true, - "comment": "Target to create new session for. For backwards-compatibility, this parameter is named `page`, but it can be a `Page` or\n`Frame` type.", - "deprecated": false, - "async": false, - "alias": "page", - "overloadIndex": 0, - "paramOrOption": null - } - ] - }, - { - "kind": "method", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "newPage", - "type": { - "name": "Page", - "expression": "[Page]" - }, - "spec": [ - { - "type": "text", - "text": "Creates a new page in the browser context." - } - ], - "required": true, - "comment": "Creates a new page in the browser context.", - "deprecated": false, - "async": true, - "alias": "newPage", - "overloadIndex": 0, - "paramOrOption": null, - "args": [] - }, - { - "kind": "method", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "pages", - "type": { - "name": "Array", - "templates": [ - { - "name": "Page" - } - ], - "expression": "[Array]<[Page]>" - }, - "spec": [ - { - "type": "text", - "text": "Returns all open pages in the context." - } - ], - "required": true, - "comment": "Returns all open pages in the context.", - "deprecated": false, - "async": false, - "alias": "pages", - "overloadIndex": 0, - "paramOrOption": null, - "args": [] + ] }, { - "kind": "property", + "kind": "method", "langs": { - "aliases": { - "csharp": "APIRequest" - }, + "only": [ + "js" + ], + "aliases": {}, "types": {}, "overrides": {} }, "experimental": false, - "since": "v1.16", - "name": "request", - "type": { - "name": "APIRequestContext", - "expression": "[APIRequestContext]" - }, - "spec": [ - { - "type": "text", - "text": "API testing helper associated with this context. Requests made with this API will use context cookies." - } - ], - "required": true, - "comment": "API testing helper associated with this context. Requests made with this API will use context cookies.", - "deprecated": false, - "async": false, - "alias": "request", - "overloadIndex": 0, - "paramOrOption": null, - "args": [] - }, - { - "kind": "method", - "langs": {}, - "experimental": false, "since": "v1.8", - "name": "route", + "name": "launchServer", "type": { - "name": "void" + "name": "BrowserServer", + "expression": "[BrowserServer]" }, "spec": [ { "type": "text", - "text": "Routing provides the capability to modify network requests that are made by any page in the browser context. Once route is enabled, every request matching the url pattern will stall unless it's continued, fulfilled or aborted." - }, - { - "type": "note", - "noteType": "note", - "text": "[`method: BrowserContext.route`] will not intercept requests intercepted by Service Worker. See [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using request interception by setting `Browser.newContext.serviceWorkers` to `'block'`." - }, - { - "type": "text", - "text": "An example of a naive handler that aborts all image requests:" - }, - { - "type": "code", - "lines": [ - "const context = await browser.newContext();", - "await context.route('**/*.{png,jpg,jpeg}', route => route.abort());", - "const page = await context.newPage();", - "await page.goto('https://example.com');", - "await browser.close();" - ], - "codeLang": "js" - }, - { - "type": "code", - "lines": [ - "BrowserContext context = browser.newContext();", - "context.route(\"**/*.{png,jpg,jpeg}\", route -> route.abort());", - "Page page = context.newPage();", - "page.navigate(\"https://example.com\");", - "browser.close();" - ], - "codeLang": "java" - }, - { - "type": "code", - "lines": [ - "context = await browser.new_context()", - "page = await context.new_page()", - "await context.route(\"**/*.{png,jpg,jpeg}\", lambda route: route.abort())", - "await page.goto(\"https://example.com\")", - "await browser.close()" - ], - "codeLang": "python async" - }, - { - "type": "code", - "lines": [ - "context = browser.new_context()", - "page = context.new_page()", - "context.route(\"**/*.{png,jpg,jpeg}\", lambda route: route.abort())", - "page.goto(\"https://example.com\")", - "browser.close()" - ], - "codeLang": "python sync" - }, - { - "type": "code", - "lines": [ - "var context = await browser.NewContextAsync();", - "var page = await context.NewPageAsync();", - "await context.RouteAsync(\"**/*.{png,jpg,jpeg}\", r => r.AbortAsync());", - "await page.GotoAsync(\"https://theverge.com\");", - "await browser.CloseAsync();" - ], - "codeLang": "csharp" + "text": "Returns the browser app instance. You can connect to it via [`method: BrowserType.connect`], which requires the major/minor client/server version to match (1.2.3 → is compatible with 1.2.x)." }, { "type": "text", - "text": "or the same snippet using a regex pattern instead:" - }, - { - "type": "code", - "lines": [ - "const context = await browser.newContext();", - "await context.route(/(\\.png$)|(\\.jpg$)/, route => route.abort());", - "const page = await context.newPage();", - "await page.goto('https://example.com');", - "await browser.close();" - ], - "codeLang": "js" - }, - { - "type": "code", - "lines": [ - "BrowserContext context = browser.newContext();", - "context.route(Pattern.compile(\"(\\\\.png$)|(\\\\.jpg$)\"), route -> route.abort());", - "Page page = context.newPage();", - "page.navigate(\"https://example.com\");", - "browser.close();" - ], - "codeLang": "java" - }, - { - "type": "code", - "lines": [ - "context = await browser.new_context()", - "page = await context.new_page()", - "await context.route(re.compile(r\"(\\.png$)|(\\.jpg$)\"), lambda route: route.abort())", - "page = await context.new_page()", - "await page.goto(\"https://example.com\")", - "await browser.close()" - ], - "codeLang": "python async" - }, - { - "type": "code", - "lines": [ - "context = browser.new_context()", - "page = context.new_page()", - "context.route(re.compile(r\"(\\.png$)|(\\.jpg$)\"), lambda route: route.abort())", - "page = await context.new_page()", - "page = context.new_page()", - "page.goto(\"https://example.com\")", - "browser.close()" - ], - "codeLang": "python sync" - }, - { - "type": "code", - "lines": [ - "var context = await browser.NewContextAsync();", - "var page = await context.NewPageAsync();", - "await context.RouteAsync(new Regex(\"(\\\\.png$)|(\\\\.jpg$)\"), r => r.AbortAsync());", - "await page.GotoAsync(\"https://theverge.com\");", - "await browser.CloseAsync();" - ], - "codeLang": "csharp" + "text": "**Usage**" }, { "type": "text", - "text": "It is possible to examine the request to decide the route action. For example, mocking all requests that contain some post data, and leaving all other requests as is:" + "text": "Launches browser server that client can connect to. An example of launching a browser executable and connecting to it↵later:" }, { "type": "code", "lines": [ - "await context.route('/api/**', route => {", - " if (route.request().postData().includes('my-string'))", - " route.fulfill({ body: 'mocked-data' });", - " else", - " route.continue();", - "});" + "const { chromium } = require('playwright'); // Or 'webkit' or 'firefox'.", + "", + "(async () => {", + " const browserServer = await chromium.launchServer();", + " const wsEndpoint = browserServer.wsEndpoint();", + " // Use web socket endpoint later to establish a connection.", + " const browser = await chromium.connect(wsEndpoint);", + " // Close browser instance.", + " await browserServer.close();", + "})();" ], "codeLang": "js" - }, - { - "type": "code", - "lines": [ - "context.route(\"/api/**\", route -> {", - " if (route.request().postData().contains(\"my-string\"))", - " route.fulfill(new Route.FulfillOptions().setBody(\"mocked-data\"));", - " else", - " route.resume();", - "});" - ], - "codeLang": "java" - }, - { - "type": "code", - "lines": [ - "def handle_route(route):", - " if (\"my-string\" in route.request.post_data)", - " route.fulfill(body=\"mocked-data\")", - " else", - " route.continue_()", - "await context.route(\"/api/**\", handle_route)" - ], - "codeLang": "python async" - }, - { - "type": "code", - "lines": [ - "def handle_route(route):", - " if (\"my-string\" in route.request.post_data)", - " route.fulfill(body=\"mocked-data\")", - " else", - " route.continue_()", - "context.route(\"/api/**\", handle_route)" - ], - "codeLang": "python sync" - }, - { - "type": "code", - "lines": [ - "await page.RouteAsync(\"/api/**\", async r =>", - "{", - " if (r.Request.PostData.Contains(\"my-string\"))", - " await r.FulfillAsync(body: \"mocked-data\");", - " else", - " await r.ContinueAsync();", - "});" - ], - "codeLang": "csharp" - }, - { - "type": "text", - "text": "Page routes (set up with [`method: Page.route`]) take precedence over browser context routes when request matches both handlers." - }, - { - "type": "text", - "text": "To remove a route with its handler you can use [`method: BrowserContext.unroute`]." - }, - { - "type": "note", - "noteType": "note", - "text": "Enabling routing disables http cache." } ], "required": true, - "comment": "Routing provides the capability to modify network requests that are made by any page in the browser context. Once route\nis enabled, every request matching the url pattern will stall unless it's continued, fulfilled or aborted.\n\n> NOTE: [`method: BrowserContext.route`] will not intercept requests intercepted by Service Worker. See\n[this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using\nrequest interception by setting `Browser.newContext.serviceWorkers` to `'block'`.\n\nAn example of a naive handler that aborts all image requests:\n\n```js\nconst context = await browser.newContext();\nawait context.route('**/*.{png,jpg,jpeg}', route => route.abort());\nconst page = await context.newPage();\nawait page.goto('https://example.com');\nawait browser.close();\n```\n\n```java\nBrowserContext context = browser.newContext();\ncontext.route(\"**/*.{png,jpg,jpeg}\", route -> route.abort());\nPage page = context.newPage();\npage.navigate(\"https://example.com\");\nbrowser.close();\n```\n\n```python async\ncontext = await browser.new_context()\npage = await context.new_page()\nawait context.route(\"**/*.{png,jpg,jpeg}\", lambda route: route.abort())\nawait page.goto(\"https://example.com\")\nawait browser.close()\n```\n\n```python sync\ncontext = browser.new_context()\npage = context.new_page()\ncontext.route(\"**/*.{png,jpg,jpeg}\", lambda route: route.abort())\npage.goto(\"https://example.com\")\nbrowser.close()\n```\n\n```csharp\nvar context = await browser.NewContextAsync();\nvar page = await context.NewPageAsync();\nawait context.RouteAsync(\"**/*.{png,jpg,jpeg}\", r => r.AbortAsync());\nawait page.GotoAsync(\"https://theverge.com\");\nawait browser.CloseAsync();\n```\n\nor the same snippet using a regex pattern instead:\n\n```js\nconst context = await browser.newContext();\nawait context.route(/(\\.png$)|(\\.jpg$)/, route => route.abort());\nconst page = await context.newPage();\nawait page.goto('https://example.com');\nawait browser.close();\n```\n\n```java\nBrowserContext context = browser.newContext();\ncontext.route(Pattern.compile(\"(\\\\.png$)|(\\\\.jpg$)\"), route -> route.abort());\nPage page = context.newPage();\npage.navigate(\"https://example.com\");\nbrowser.close();\n```\n\n```python async\ncontext = await browser.new_context()\npage = await context.new_page()\nawait context.route(re.compile(r\"(\\.png$)|(\\.jpg$)\"), lambda route: route.abort())\npage = await context.new_page()\nawait page.goto(\"https://example.com\")\nawait browser.close()\n```\n\n```python sync\ncontext = browser.new_context()\npage = context.new_page()\ncontext.route(re.compile(r\"(\\.png$)|(\\.jpg$)\"), lambda route: route.abort())\npage = await context.new_page()\npage = context.new_page()\npage.goto(\"https://example.com\")\nbrowser.close()\n```\n\n```csharp\nvar context = await browser.NewContextAsync();\nvar page = await context.NewPageAsync();\nawait context.RouteAsync(new Regex(\"(\\\\.png$)|(\\\\.jpg$)\"), r => r.AbortAsync());\nawait page.GotoAsync(\"https://theverge.com\");\nawait browser.CloseAsync();\n```\n\nIt is possible to examine the request to decide the route action. For example, mocking all requests that contain some\npost data, and leaving all other requests as is:\n\n```js\nawait context.route('/api/**', route => {\n if (route.request().postData().includes('my-string'))\n route.fulfill({ body: 'mocked-data' });\n else\n route.continue();\n});\n```\n\n```java\ncontext.route(\"/api/**\", route -> {\n if (route.request().postData().contains(\"my-string\"))\n route.fulfill(new Route.FulfillOptions().setBody(\"mocked-data\"));\n else\n route.resume();\n});\n```\n\n```python async\ndef handle_route(route):\n if (\"my-string\" in route.request.post_data)\n route.fulfill(body=\"mocked-data\")\n else\n route.continue_()\nawait context.route(\"/api/**\", handle_route)\n```\n\n```python sync\ndef handle_route(route):\n if (\"my-string\" in route.request.post_data)\n route.fulfill(body=\"mocked-data\")\n else\n route.continue_()\ncontext.route(\"/api/**\", handle_route)\n```\n\n```csharp\nawait page.RouteAsync(\"/api/**\", async r =>\n{\n if (r.Request.PostData.Contains(\"my-string\"))\n await r.FulfillAsync(body: \"mocked-data\");\n else\n await r.ContinueAsync();\n});\n```\n\nPage routes (set up with [`method: Page.route`]) take precedence over browser context routes when request matches both\nhandlers.\n\nTo remove a route with its handler you can use [`method: BrowserContext.unroute`].\n\n> NOTE: Enabling routing disables http cache.", - "deprecated": false, + "comment": "Returns the browser app instance. You can connect to it via [`method: BrowserType.connect`], which requires the\nmajor/minor client/server version to match (1.2.3 → is compatible with 1.2.x).\n\n**Usage**\n\nLaunches browser server that client can connect to. An example of launching a browser executable and connecting to\nit later:\n\n```js\nconst { chromium } = require('playwright'); // Or 'webkit' or 'firefox'.\n\n(async () => {\n const browserServer = await chromium.launchServer();\n const wsEndpoint = browserServer.wsEndpoint();\n // Use web socket endpoint later to establish a connection.\n const browser = await chromium.connect(wsEndpoint);\n // Close browser instance.\n await browserServer.close();\n})();\n```\n", "async": true, - "alias": "route", + "alias": "launchServer", "overloadIndex": 0, "paramOrOption": null, "args": [ @@ -21385,139 +29701,504 @@ "kind": "property", "langs": {}, "experimental": false, - "since": "v1.8", - "name": "url", + "since": "v1.0", + "name": "options", "type": { - "name": "", - "union": [ + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "args", + "type": { + "name": "Array", + "templates": [ + { + "name": "string" + } + ], + "expression": "[Array]<[string]>" + }, + "spec": [ + { + "type": "text", + "text": "Additional arguments to pass to the browser instance. The list of Chromium flags can be found↵[here](http://peter.sh/experiments/chromium-command-line-switches/)." + } + ], + "required": false, + "comment": "Additional arguments to pass to the browser instance. The list of Chromium flags can be found\n[here](http://peter.sh/experiments/chromium-command-line-switches/).", + "async": false, + "alias": "args", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "channel", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Browser distribution channel. Supported values are \"chrome\", \"chrome-beta\", \"chrome-dev\", \"chrome-canary\", \"msedge\", \"msedge-beta\", \"msedge-dev\", \"msedge-canary\". Read more about using [Google Chrome and Microsoft Edge](../browsers.md#google-chrome--microsoft-edge)." + } + ], + "required": false, + "comment": "Browser distribution channel. Supported values are \"chrome\", \"chrome-beta\", \"chrome-dev\", \"chrome-canary\",\n\"msedge\", \"msedge-beta\", \"msedge-dev\", \"msedge-canary\". Read more about using\n[Google Chrome and Microsoft Edge](../browsers.md#google-chrome--microsoft-edge).", + "async": false, + "alias": "channel", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "chromiumSandbox", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Enable Chromium sandboxing. Defaults to `false`." + } + ], + "required": false, + "comment": "Enable Chromium sandboxing. Defaults to `false`.", + "async": false, + "alias": "chromiumSandbox", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "devtools", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "**Chromium-only** Whether to auto-open a Developer Tools panel for each tab. If this option is `true`, the↵`headless` option will be set `false`." + } + ], + "required": false, + "comment": "**Chromium-only** Whether to auto-open a Developer Tools panel for each tab. If this option is `true`, the\n`headless` option will be set `false`.", + "async": false, + "alias": "devtools", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "downloadsPath", + "type": { + "name": "path", + "expression": "[path]" + }, + "spec": [ + { + "type": "text", + "text": "If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is↵deleted when browser is closed. In either case, the downloads are deleted when the browser context they were created in↵is closed." + } + ], + "required": false, + "comment": "If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and\nis deleted when browser is closed. In either case, the downloads are deleted when the browser context they were\ncreated in is closed.", + "async": false, + "alias": "downloadsPath", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "env", + "type": { + "name": "Object", + "templates": [ + { + "name": "string" + }, + { + "name": "string" + } + ], + "expression": "[Object]<[string], [string]>" + }, + "spec": [ + { + "type": "text", + "text": "Specify environment variables that will be visible to the browser. Defaults to `process.env`." + } + ], + "required": false, + "comment": "Specify environment variables that will be visible to the browser. Defaults to `process.env`.", + "async": false, + "alias": "env", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "env", + "type": { + "name": "Object", + "templates": [ + { + "name": "string" + }, + { + "name": "", + "union": [ + { + "name": "string" + }, + { + "name": "float" + }, + { + "name": "boolean" + } + ] + } + ], + "expression": "[Object]<[string], [string]|[float]|[boolean]>" + }, + "spec": [ + { + "type": "text", + "text": "Specify environment variables that will be visible to the browser. Defaults to `process.env`." + } + ], + "required": false, + "comment": "Specify environment variables that will be visible to the browser. Defaults to `process.env`.", + "async": false, + "alias": "env", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "executablePath", + "type": { + "name": "path", + "expression": "[path]" + }, + "spec": [ + { + "type": "text", + "text": "Path to a browser executable to run instead of the bundled one. If `executablePath` is a relative path, then↵it is resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium,↵Firefox or WebKit, use at your own risk." + } + ], + "required": false, + "comment": "Path to a browser executable to run instead of the bundled one. If `executablePath` is a relative path, then it is\nresolved relative to the current working directory. Note that Playwright only works with the bundled Chromium,\nFirefox or WebKit, use at your own risk.", + "async": false, + "alias": "executablePath", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "firefoxUserPrefs", + "type": { + "name": "Object", + "templates": [ + { + "name": "string" + }, + { + "name": "", + "union": [ + { + "name": "string" + }, + { + "name": "float" + }, + { + "name": "boolean" + } + ] + } + ], + "expression": "[Object]<[string], [string]|[float]|[boolean]>" + }, + "spec": [ + { + "type": "text", + "text": "Firefox user preferences. Learn more about the Firefox user preferences at↵[`about:config`](https://support.mozilla.org/en-US/kb/about-config-editor-firefox)." + } + ], + "required": false, + "comment": "Firefox user preferences. Learn more about the Firefox user preferences at\n[`about:config`](https://support.mozilla.org/en-US/kb/about-config-editor-firefox).", + "async": false, + "alias": "firefoxUserPrefs", + "overloadIndex": 0, + "paramOrOption": null + }, { - "name": "string" + "kind": "property", + "langs": { + "only": [ + "csharp", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "firefoxUserPrefs", + "type": { + "name": "Object", + "templates": [ + { + "name": "string" + }, + { + "name": "any" + } + ], + "expression": "[Object]<[string], [any]>" + }, + "spec": [ + { + "type": "text", + "text": "Firefox user preferences. Learn more about the Firefox user preferences at↵[`about:config`](https://support.mozilla.org/en-US/kb/about-config-editor-firefox)." + } + ], + "required": false, + "comment": "Firefox user preferences. Learn more about the Firefox user preferences at\n[`about:config`](https://support.mozilla.org/en-US/kb/about-config-editor-firefox).", + "async": false, + "alias": "firefoxUserPrefs", + "overloadIndex": 0, + "paramOrOption": null }, { - "name": "RegExp" + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "handleSIGHUP", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Close the browser process on SIGHUP. Defaults to `true`." + } + ], + "required": false, + "comment": "Close the browser process on SIGHUP. Defaults to `true`.", + "async": false, + "alias": "handleSIGHUP", + "overloadIndex": 0, + "paramOrOption": null }, { - "name": "function", - "args": [ + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "handleSIGINT", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ { - "name": "URL" + "type": "text", + "text": "Close the browser process on Ctrl-C. Defaults to `true`." } ], - "returnType": { - "name": "boolean" - } - } - ], - "expression": "[string]|[RegExp]|[function]([URL]):[boolean]" - }, - "spec": [ - { - "type": "text", - "text": "A glob pattern, regex pattern or predicate receiving [URL] to match while routing. When a `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." - } - ], - "required": true, - "comment": "A glob pattern, regex pattern or predicate receiving [URL] to match while routing. When a `baseURL` via the context\noptions was provided and the passed URL is a path, it gets merged via the\n[`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor.", - "deprecated": false, - "async": false, - "alias": "url", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": { - "only": [ - "js", - "python" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.8", - "name": "handler", - "type": { - "name": "function", - "args": [ + "required": false, + "comment": "Close the browser process on Ctrl-C. Defaults to `true`.", + "async": false, + "alias": "handleSIGINT", + "overloadIndex": 0, + "paramOrOption": null + }, { - "name": "Route" + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "handleSIGTERM", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Close the browser process on SIGTERM. Defaults to `true`." + } + ], + "required": false, + "comment": "Close the browser process on SIGTERM. Defaults to `true`.", + "async": false, + "alias": "handleSIGTERM", + "overloadIndex": 0, + "paramOrOption": null }, { - "name": "Request" - } - ], - "returnType": null, - "expression": "[function]([Route], [Request])" - }, - "spec": [ - { - "type": "text", - "text": "handler function to route the request." - } - ], - "required": true, - "comment": "handler function to route the request.", - "deprecated": false, - "async": false, - "alias": "handler", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": { - "only": [ - "csharp", - "java" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.8", - "name": "handler", - "type": { - "name": "function", - "args": [ + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "headless", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Whether to run browser in headless mode. More details for↵[Chromium](https://developers.google.com/web/updates/2017/04/headless-chrome) and↵[Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Firefox/Headless_mode). Defaults to `true` unless the↵`devtools` option is `true`." + } + ], + "required": false, + "comment": "Whether to run browser in headless mode. More details for\n[Chromium](https://developers.google.com/web/updates/2017/04/headless-chrome) and\n[Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Firefox/Headless_mode). Defaults to `true` unless the\n`devtools` option is `true`.", + "async": false, + "alias": "headless", + "overloadIndex": 0, + "paramOrOption": null + }, { - "name": "Route" - } - ], - "returnType": null, - "expression": "[function]([Route])" - }, - "spec": [ - { - "type": "text", - "text": "handler function to route the request." - } - ], - "required": true, - "comment": "handler function to route the request.", - "deprecated": false, - "async": false, - "alias": "handler", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "options", - "type": { - "name": "Object", - "properties": [ + "kind": "property", + "langs": { + "only": [ + "js", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "ignoreDefaultArgs", + "type": { + "name": "", + "union": [ + { + "name": "boolean" + }, + { + "name": "Array", + "templates": [ + { + "name": "string" + } + ] + } + ], + "expression": "[boolean]|[Array]<[string]>" + }, + "spec": [ + { + "type": "text", + "text": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. If an↵array is given, then filters out the given default arguments. Dangerous option; use with care. Defaults to `false`." + } + ], + "required": false, + "comment": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. If an array is\ngiven, then filters out the given default arguments. Dangerous option; use with care. Defaults to `false`.", + "async": false, + "alias": "ignoreDefaultArgs", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "logger", + "type": { + "name": "Logger", + "expression": "[Logger]" + }, + "spec": [ + { + "type": "text", + "text": "Logger sink for Playwright logging." + } + ], + "required": false, + "comment": "Logger sink for Playwright logging.", + "async": false, + "alias": "logger", + "overloadIndex": 0, + "paramOrOption": null + }, { "kind": "property", "langs": {}, "experimental": false, - "since": "v1.15", - "name": "times", + "since": "v1.8", + "name": "port", "type": { "name": "int", "expression": "[int]" @@ -21525,128 +30206,153 @@ "spec": [ { "type": "text", - "text": "How often a route should be used. By default it will be used every time." + "text": "Port to use for the web socket. Defaults to 0 that picks any available port." } ], "required": false, - "comment": "How often a route should be used. By default it will be used every time.", - "deprecated": false, + "comment": "Port to use for the web socket. Defaults to 0 that picks any available port.", "async": false, - "alias": "times", + "alias": "port", "overloadIndex": 0, "paramOrOption": null - } - ] - }, - "required": false, - "comment": "", - "deprecated": false, - "async": false, - "alias": "options", - "overloadIndex": 0, - "paramOrOption": null - } - ] - }, - { - "kind": "method", - "langs": {}, - "experimental": false, - "since": "v1.23", - "name": "routeFromHAR", - "type": { - "name": "void" - }, - "spec": [ - { - "type": "text", - "text": "If specified the network requests that are made in the context will be served from the HAR file. Read more about [Replaying from HAR](../network.md#replaying-from-har)." - }, - { - "type": "text", - "text": "Playwright will not serve requests intercepted by Service Worker from the HAR file. See [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using request interception by setting `Browser.newContext.serviceWorkers` to `'block'`." - } - ], - "required": true, - "comment": "If specified the network requests that are made in the context will be served from the HAR file. Read more about\n[Replaying from HAR](../network.md#replaying-from-har).\n\nPlaywright will not serve requests intercepted by Service Worker from the HAR file. See\n[this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using\nrequest interception by setting `Browser.newContext.serviceWorkers` to `'block'`.", - "deprecated": false, - "async": true, - "alias": "routeFromHAR", - "overloadIndex": 0, - "paramOrOption": null, - "args": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.23", - "name": "har", - "type": { - "name": "path", - "expression": "[path]" - }, - "spec": [ - { - "type": "text", - "text": "Path to a [HAR](http://www.softwareishard.com/blog/har-12-spec) file with prerecorded network data. If `path` is a relative path, then it is resolved relative to the current working directory." - } - ], - "required": true, - "comment": "Path to a [HAR](http://www.softwareishard.com/blog/har-12-spec) file with prerecorded network data. If `path` is a\nrelative path, then it is resolved relative to the current working directory.", - "deprecated": false, - "async": false, - "alias": "har", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "options", - "type": { - "name": "Object", - "properties": [ + }, { "kind": "property", "langs": {}, "experimental": false, - "since": "v1.23", - "name": "notFound", + "since": "v1.8", + "name": "proxy", "type": { - "name": "HarNotFound", - "union": [ + "name": "Object", + "properties": [ { - "name": "\"abort\"" + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "server", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example↵`http://myproxy.com:3128` or `socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP↵proxy." + } + ], + "required": true, + "comment": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example `http://myproxy.com:3128` or\n`socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP proxy.", + "async": false, + "alias": "server", + "overloadIndex": 0, + "paramOrOption": null }, { - "name": "\"fallback\"" + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "bypass", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Optional comma-separated domains to bypass proxy, for example `\".com, chromium.org,↵.domain.com\"`." + } + ], + "required": false, + "comment": "Optional comma-separated domains to bypass proxy, for example `\".com, chromium.org, .domain.com\"`.", + "async": false, + "alias": "bypass", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "username", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Optional username to use if HTTP proxy requires authentication." + } + ], + "required": false, + "comment": "Optional username to use if HTTP proxy requires authentication.", + "async": false, + "alias": "username", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "password", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "Optional password to use if HTTP proxy requires authentication." + } + ], + "required": false, + "comment": "Optional password to use if HTTP proxy requires authentication.", + "async": false, + "alias": "password", + "overloadIndex": 0, + "paramOrOption": null } ], - "expression": "[HarNotFound]<\"abort\"|\"fallback\">" + "expression": "[Object]" }, "spec": [ { - "type": "li", - "text": "If set to 'abort' any request not found in the HAR file will be aborted.", - "liType": "bullet" - }, - { - "type": "li", - "text": "If set to 'fallback' falls through to the next route handler in the handler chain.", - "liType": "bullet" - }, + "type": "text", + "text": "Network proxy settings." + } + ], + "required": false, + "comment": "Network proxy settings.", + "async": false, + "alias": "proxy", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "timeout", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ { "type": "text", - "text": "Defaults to abort." + "text": "Maximum time in milliseconds to wait for the browser instance to start. Defaults to `30000` (30 seconds). Pass `0` to↵disable timeout." } ], "required": false, - "comment": "- If set to 'abort' any request not found in the HAR file will be aborted.\n- If set to 'fallback' falls through to the next route handler in the handler chain.\n\nDefaults to abort.", - "deprecated": false, + "comment": "Maximum time in milliseconds to wait for the browser instance to start. Defaults to `30000` (30 seconds). Pass `0`\nto disable timeout.", "async": false, - "alias": "notFound", + "alias": "timeout", "overloadIndex": 0, "paramOrOption": null }, @@ -21654,23 +30360,22 @@ "kind": "property", "langs": {}, "experimental": false, - "since": "v1.23", - "name": "update", + "since": "v1.8", + "name": "tracesDir", "type": { - "name": "boolean", - "expression": "boolean" + "name": "path", + "expression": "[path]" }, "spec": [ { "type": "text", - "text": "If specified, updates the given HAR with the actual network information instead of serving from file." + "text": "If specified, traces are saved into this directory." } ], "required": false, - "comment": "If specified, updates the given HAR with the actual network information instead of serving from file.", - "deprecated": false, + "comment": "If specified, traces are saved into this directory.", "async": false, - "alias": "update", + "alias": "tracesDir", "overloadIndex": 0, "paramOrOption": null }, @@ -21678,31 +30383,27 @@ "kind": "property", "langs": {}, "experimental": false, - "since": "v1.23", - "name": "url", + "since": "v1.15", + "name": "wsPath", "type": { - "name": "", - "union": [ - { - "name": "string" - }, - { - "name": "RegExp" - } - ], - "expression": "[string]|[RegExp]" + "name": "string", + "expression": "[string]" }, "spec": [ { "type": "text", - "text": "A glob pattern, regular expression or predicate to match the request URL. Only requests with URL matching the pattern will be served from the HAR file. If not specified, all requests are served from the HAR file." + "text": "Path at which to serve the Browser Server. For security, this defaults to an↵unguessable string." + }, + { + "type": "note", + "noteType": "warning", + "text": "Any process or web page (including those running in Playwright) with knowledge↵of the `wsPath` can take control of the OS user. For this reason, you should↵use an unguessable token when using this option." } ], "required": false, - "comment": "A glob pattern, regular expression or predicate to match the request URL. Only requests with URL matching the pattern\nwill be served from the HAR file. If not specified, all requests are served from the HAR file.", - "deprecated": false, + "comment": "Path at which to serve the Browser Server. For security, this defaults to an unguessable string.\n\n**NOTE** Any process or web page (including those running in Playwright) with knowledge of the `wsPath` can take\ncontrol of the OS user. For this reason, you should use an unguessable token when using this option.", "async": false, - "alias": "url", + "alias": "wsPath", "overloadIndex": 0, "paramOrOption": null } @@ -21710,7 +30411,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -21720,412 +30420,291 @@ }, { "kind": "method", - "langs": { - "only": [ - "js", - "python" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, + "langs": {}, "experimental": false, - "since": "v1.11", - "name": "serviceWorkers", + "since": "v1.8", + "name": "name", "type": { - "name": "Array", - "templates": [ - { - "name": "Worker" - } - ], - "expression": "[Array]<[Worker]>" + "name": "string", + "expression": "[string]" }, "spec": [ - { - "type": "note", - "noteType": "note", - "text": "Service workers are only supported on Chromium-based browsers." - }, { "type": "text", - "text": "All existing service workers in the context." + "text": "Returns browser name. For example: `'chromium'`, `'webkit'` or `'firefox'`." } ], "required": true, - "comment": "> NOTE: Service workers are only supported on Chromium-based browsers.\n\nAll existing service workers in the context.", - "deprecated": false, + "comment": "Returns browser name. For example: `'chromium'`, `'webkit'` or `'firefox'`.", "async": false, - "alias": "serviceWorkers", + "alias": "name", "overloadIndex": 0, "paramOrOption": null, "args": [] + } + ] + }, + { + "name": "CDPSession", + "spec": [ + { + "type": "li", + "text": "extends: [EventEmitter]", + "liType": "bullet" + }, + { + "type": "text", + "text": "The `CDPSession` instances are used to talk raw Chrome Devtools Protocol:" + }, + { + "type": "li", + "text": "protocol methods can be called with `session.send` method.", + "liType": "bullet" + }, + { + "type": "li", + "text": "protocol events can be subscribed to with `session.on` method.", + "liType": "bullet" + }, + { + "type": "text", + "text": "Useful links:" + }, + { + "type": "li", + "text": "Documentation on DevTools Protocol can be found here:↵[DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/).", + "liType": "bullet" + }, + { + "type": "li", + "text": "Getting Started with DevTools Protocol:↵https://github.com/aslushnikov/getting-started-with-cdp/blob/master/README.md", + "liType": "bullet" + }, + { + "type": "code", + "lines": [ + "const client = await page.context().newCDPSession(page);", + "await client.send('Animation.enable');", + "client.on('Animation.animationCreated', () => console.log('Animation created!'));", + "const response = await client.send('Animation.getPlaybackRate');", + "console.log('playback rate is ' + response.playbackRate);", + "await client.send('Animation.setPlaybackRate', {", + " playbackRate: response.playbackRate / 2", + "});" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "client = await page.context.new_cdp_session(page)", + "await client.send(\"Animation.enable\")", + "client.on(\"Animation.animationCreated\", lambda: print(\"animation created!\"))", + "response = await client.send(\"Animation.getPlaybackRate\")", + "print(\"playback rate is \" + str(response[\"playbackRate\"]))", + "await client.send(\"Animation.setPlaybackRate\", {", + " playbackRate: response[\"playbackRate\"] / 2", + "})" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "client = page.context.new_cdp_session(page)", + "client.send(\"Animation.enable\")", + "client.on(\"Animation.animationCreated\", lambda: print(\"animation created!\"))", + "response = client.send(\"Animation.getPlaybackRate\")", + "print(\"playback rate is \" + str(response[\"playbackRate\"]))", + "client.send(\"Animation.setPlaybackRate\", {", + " playbackRate: response[\"playbackRate\"] / 2", + "})" + ], + "codeLang": "python sync" }, + { + "type": "code", + "lines": [ + "var client = await Page.Context.NewCDPSessionAsync(Page);", + "await client.SendAsync(\"Runtime.enable\");", + "client.Event(\"Animation.animationCreated\").OnEvent += (_, _) => Console.WriteLine(\"Animation created!\");", + "var response = await client.SendAsync(\"Animation.getPlaybackRate\");", + "var playbackRate = response.Value.GetProperty(\"playbackRate\").GetDouble();", + "Console.WriteLine(\"playback rate is \" + playbackRate);", + "await client.SendAsync(\"Animation.setPlaybackRate\", new() { { \"playbackRate\", playbackRate / 2 } });" + ], + "codeLang": "csharp" + } + ], + "extends": "EventEmitter", + "langs": { + "only": [ + "js", + "python", + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "comment": "- extends: [EventEmitter]\n\nThe `CDPSession` instances are used to talk raw Chrome Devtools Protocol:\n- protocol methods can be called with `session.send` method.\n- protocol events can be subscribed to with `session.on` method.\n\nUseful links:\n- Documentation on DevTools Protocol can be found here:\n [DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/).\n- Getting Started with DevTools Protocol:\n https://github.com/aslushnikov/getting-started-with-cdp/blob/master/README.md\n\n```js\nconst client = await page.context().newCDPSession(page);\nawait client.send('Animation.enable');\nclient.on('Animation.animationCreated', () => console.log('Animation created!'));\nconst response = await client.send('Animation.getPlaybackRate');\nconsole.log('playback rate is ' + response.playbackRate);\nawait client.send('Animation.setPlaybackRate', {\n playbackRate: response.playbackRate / 2\n});\n```\n\n```py\nclient = await page.context.new_cdp_session(page)\nawait client.send(\"Animation.enable\")\nclient.on(\"Animation.animationCreated\", lambda: print(\"animation created!\"))\nresponse = await client.send(\"Animation.getPlaybackRate\")\nprint(\"playback rate is \" + str(response[\"playbackRate\"]))\nawait client.send(\"Animation.setPlaybackRate\", {\n playbackRate: response[\"playbackRate\"] / 2\n})\n```\n\n```py\nclient = page.context.new_cdp_session(page)\nclient.send(\"Animation.enable\")\nclient.on(\"Animation.animationCreated\", lambda: print(\"animation created!\"))\nresponse = client.send(\"Animation.getPlaybackRate\")\nprint(\"playback rate is \" + str(response[\"playbackRate\"]))\nclient.send(\"Animation.setPlaybackRate\", {\n playbackRate: response[\"playbackRate\"] / 2\n})\n```\n\n```csharp\nvar client = await Page.Context.NewCDPSessionAsync(Page);\nawait client.SendAsync(\"Runtime.enable\");\nclient.Event(\"Animation.animationCreated\").OnEvent += (_, _) => Console.WriteLine(\"Animation created!\");\nvar response = await client.SendAsync(\"Animation.getPlaybackRate\");\nvar playbackRate = response.Value.GetProperty(\"playbackRate\").GetDouble();\nConsole.WriteLine(\"playback rate is \" + playbackRate);\nawait client.SendAsync(\"Animation.setPlaybackRate\", new() { { \"playbackRate\", playbackRate / 2 } });\n```\n", + "since": "v1.8", + "members": [ { "kind": "method", "langs": {}, "experimental": false, "since": "v1.8", - "name": "setDefaultNavigationTimeout", + "name": "detach", "type": { "name": "void" }, "spec": [ { "type": "text", - "text": "This setting will change the default maximum navigation time for the following methods and related shortcuts:" - }, - { - "type": "li", - "text": "[`method: Page.goBack`]", - "liType": "bullet" - }, - { - "type": "li", - "text": "[`method: Page.goForward`]", - "liType": "bullet" - }, - { - "type": "li", - "text": "[`method: Page.goto`]", - "liType": "bullet" - }, - { - "type": "li", - "text": "[`method: Page.reload`]", - "liType": "bullet" - }, - { - "type": "li", - "text": "[`method: Page.setContent`]", - "liType": "bullet" - }, - { - "type": "li", - "text": "[`method: Page.waitForNavigation`]", - "liType": "bullet" - }, - { - "type": "note", - "noteType": "note", - "text": "[`method: Page.setDefaultNavigationTimeout`] and [`method: Page.setDefaultTimeout`] take priority over [`method: BrowserContext.setDefaultNavigationTimeout`]." + "text": "Detaches the CDPSession from the target. Once detached, the CDPSession object won't emit any events and can't be used to↵send messages." } ], "required": true, - "comment": "This setting will change the default maximum navigation time for the following methods and related shortcuts:\n- [`method: Page.goBack`]\n- [`method: Page.goForward`]\n- [`method: Page.goto`]\n- [`method: Page.reload`]\n- [`method: Page.setContent`]\n- [`method: Page.waitForNavigation`]\n\n> NOTE: [`method: Page.setDefaultNavigationTimeout`] and [`method: Page.setDefaultTimeout`] take priority over\n[`method: BrowserContext.setDefaultNavigationTimeout`].", - "deprecated": false, - "async": false, - "alias": "setDefaultNavigationTimeout", + "comment": "Detaches the CDPSession from the target. Once detached, the CDPSession object won't emit any events and can't be\nused to send messages.", + "async": true, + "alias": "detach", "overloadIndex": 0, "paramOrOption": null, - "args": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "timeout", - "type": { - "name": "float", - "expression": "[float]" - }, - "spec": [ - { - "type": "text", - "text": "Maximum navigation time in milliseconds" - } - ], - "required": true, - "comment": "Maximum navigation time in milliseconds", - "deprecated": false, - "async": false, - "alias": "timeout", - "overloadIndex": 0, - "paramOrOption": null - } - ] + "args": [] }, { "kind": "method", - "langs": {}, + "langs": { + "only": [ + "js", + "python", + "csharp" + ], + "aliases": {}, + "types": { + "csharp": { + "name": "JsonElement?", + "expression": "[JsonElement?]" + } + }, + "overrides": {} + }, "experimental": false, "since": "v1.8", - "name": "setDefaultTimeout", + "name": "send", "type": { - "name": "void" + "name": "Object", + "expression": "[Object]" }, - "spec": [ - { - "type": "text", - "text": "This setting will change the default maximum time for all the methods accepting `timeout` option." - }, - { - "type": "note", - "noteType": "note", - "text": "[`method: Page.setDefaultNavigationTimeout`], [`method: Page.setDefaultTimeout`] and [`method: BrowserContext.setDefaultNavigationTimeout`] take priority over [`method: BrowserContext.setDefaultTimeout`]." - } - ], + "spec": [], "required": true, - "comment": "This setting will change the default maximum time for all the methods accepting `timeout` option.\n\n> NOTE: [`method: Page.setDefaultNavigationTimeout`], [`method: Page.setDefaultTimeout`] and\n[`method: BrowserContext.setDefaultNavigationTimeout`] take priority over [`method: BrowserContext.setDefaultTimeout`].", - "deprecated": false, - "async": false, - "alias": "setDefaultTimeout", + "comment": "", + "async": true, + "alias": "send", "overloadIndex": 0, "paramOrOption": null, "args": [ { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "js", + "python", + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, "since": "v1.8", - "name": "timeout", + "name": "method", "type": { - "name": "float", - "expression": "[float]" + "name": "string", + "expression": "[string]" }, "spec": [ { "type": "text", - "text": "Maximum time in milliseconds" + "text": "Protocol method name." } ], "required": true, - "comment": "Maximum time in milliseconds", - "deprecated": false, + "comment": "Protocol method name.", "async": false, - "alias": "timeout", + "alias": "method", "overloadIndex": 0, "paramOrOption": null - } - ] - }, - { - "kind": "method", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "setExtraHTTPHeaders", - "type": { - "name": "void" - }, - "spec": [ - { - "type": "text", - "text": "The extra HTTP headers will be sent with every request initiated by any page in the context. These headers are merged with page-specific extra HTTP headers set with [`method: Page.setExtraHTTPHeaders`]. If page overrides a particular header, page-specific header value will be used instead of the browser context header value." }, - { - "type": "note", - "noteType": "note", - "text": "[`method: BrowserContext.setExtraHTTPHeaders`] does not guarantee the order of headers in the outgoing requests." - } - ], - "required": true, - "comment": "The extra HTTP headers will be sent with every request initiated by any page in the context. These headers are merged\nwith page-specific extra HTTP headers set with [`method: Page.setExtraHTTPHeaders`]. If page overrides a particular\nheader, page-specific header value will be used instead of the browser context header value.\n\n> NOTE: [`method: BrowserContext.setExtraHTTPHeaders`] does not guarantee the order of headers in the outgoing requests.", - "deprecated": false, - "async": true, - "alias": "setExtraHTTPHeaders", - "overloadIndex": 0, - "paramOrOption": null, - "args": [ { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "js", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, "since": "v1.8", - "name": "headers", + "name": "params", "type": { "name": "Object", - "templates": [ - { - "name": "string" - }, - { - "name": "string" - } - ], - "expression": "[Object]<[string], [string]>" + "expression": "[Object]" }, "spec": [ { "type": "text", - "text": "An object containing additional HTTP headers to be sent with every request. All header values must be strings." + "text": "Optional method parameters." } ], - "required": true, - "comment": "An object containing additional HTTP headers to be sent with every request. All header values must be strings.", - "deprecated": false, + "required": false, + "comment": "Optional method parameters.", "async": false, - "alias": "headers", + "alias": "params", "overloadIndex": 0, - "paramOrOption": null - } - ] - }, - { - "kind": "method", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "setGeolocation", - "type": { - "name": "void" - }, - "spec": [ - { - "type": "text", - "text": "Sets the context's geolocation. Passing `null` or `undefined` emulates position unavailable." - }, - { - "type": "code", - "lines": [ - "await browserContext.setGeolocation({latitude: 59.95, longitude: 30.31667});" - ], - "codeLang": "js" - }, - { - "type": "code", - "lines": [ - "browserContext.setGeolocation(new Geolocation(59.95, 30.31667));" - ], - "codeLang": "java" - }, - { - "type": "code", - "lines": [ - "await browser_context.set_geolocation({\"latitude\": 59.95, \"longitude\": 30.31667})" - ], - "codeLang": "python async" - }, - { - "type": "code", - "lines": [ - "browser_context.set_geolocation({\"latitude\": 59.95, \"longitude\": 30.31667})" - ], - "codeLang": "python sync" - }, - { - "type": "code", - "lines": [ - "await context.SetGeolocationAsync(new Geolocation()", - "{", - " Latitude = 59.95f,", - " Longitude = 30.31667f", - "});" - ], - "codeLang": "csharp" - }, - { - "type": "note", - "noteType": "note", - "text": "Consider using [`method: BrowserContext.grantPermissions`] to grant permissions for the browser context pages to read its geolocation." - } - ], - "required": true, - "comment": "Sets the context's geolocation. Passing `null` or `undefined` emulates position unavailable.\n\n```js\nawait browserContext.setGeolocation({latitude: 59.95, longitude: 30.31667});\n```\n\n```java\nbrowserContext.setGeolocation(new Geolocation(59.95, 30.31667));\n```\n\n```python async\nawait browser_context.set_geolocation({\"latitude\": 59.95, \"longitude\": 30.31667})\n```\n\n```python sync\nbrowser_context.set_geolocation({\"latitude\": 59.95, \"longitude\": 30.31667})\n```\n\n```csharp\nawait context.SetGeolocationAsync(new Geolocation()\n{\n Latitude = 59.95f,\n Longitude = 30.31667f\n});\n```\n\n> NOTE: Consider using [`method: BrowserContext.grantPermissions`] to grant permissions for the browser context pages to\nread its geolocation.", - "deprecated": false, - "async": true, - "alias": "setGeolocation", - "overloadIndex": 0, - "paramOrOption": null, - "args": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "geolocation", - "type": { - "name": "", - "union": [ - { - "name": "null" - }, - { - "name": "Object", - "properties": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "latitude", - "type": { - "name": "float", - "expression": "[float]" - }, - "spec": [ - { - "type": "text", - "text": "Latitude between -90 and 90." - } - ], - "required": true, - "comment": "Latitude between -90 and 90.", - "deprecated": false, - "async": false, - "alias": "latitude", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "longitude", - "type": { - "name": "float", - "expression": "[float]" - }, - "spec": [ - { - "type": "text", - "text": "Longitude between -180 and 180." - } - ], - "required": true, - "comment": "Longitude between -180 and 180.", - "deprecated": false, - "async": false, - "alias": "longitude", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "accuracy", - "type": { - "name": "float", - "expression": "[float]" - }, - "spec": [ - { - "type": "text", - "text": "Non-negative accuracy value. Defaults to `0`." - } - ], - "required": false, - "comment": "Non-negative accuracy value. Defaults to `0`.", - "deprecated": false, - "async": false, - "alias": "accuracy", - "overloadIndex": 0, - "paramOrOption": null - } - ] + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "only": [ + "csharp" + ], + "aliases": { + "csharp": "args" + }, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.30", + "name": "params", + "type": { + "name": "Map", + "templates": [ + { + "name": "string" + }, + { + "name": "Object" } ], - "expression": "[null]|[Object]" + "expression": "[Map]" }, - "spec": [], - "required": true, - "comment": "", - "deprecated": false, + "spec": [ + { + "type": "text", + "text": "Optional method parameters." + } + ], + "required": false, + "comment": "Optional method parameters.", "async": false, - "alias": "geolocation", + "alias": "params", "overloadIndex": 0, "paramOrOption": null } @@ -22135,406 +30714,335 @@ "kind": "method", "langs": { "only": [ - "js" + "csharp" ], "aliases": {}, "types": {}, "overrides": {} }, "experimental": false, - "since": "v1.8", - "name": "setHTTPCredentials", + "since": "v.1.30", + "name": "event", "type": { - "name": "void" + "name": "CDPSessionEvent", + "expression": "[CDPSessionEvent]" }, "spec": [ { "type": "text", - "text": "**DEPRECATED** Browsers may cache credentials after successful authentication. Create a new browser context instead." + "text": "Returns an event emitter for the given CDP event name." } ], "required": true, - "comment": "**DEPRECATED** Browsers may cache credentials after successful authentication. Create a new browser context instead.", - "deprecated": true, - "async": true, - "alias": "setHTTPCredentials", + "comment": "Returns an event emitter for the given CDP event name.", + "async": false, + "alias": "event", "overloadIndex": 0, "paramOrOption": null, "args": [ { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, - "since": "v1.8", - "name": "httpCredentials", + "since": "v1.30", + "name": "eventName", "type": { - "name": "", - "union": [ - { - "name": "null" - }, - { - "name": "Object", - "properties": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "username", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "" - } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "username", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "password", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "" - } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "password", - "overloadIndex": 0, - "paramOrOption": null - } - ] - } - ], - "expression": "[null]|[Object]" + "name": "string", + "expression": "[string]" }, - "spec": [], + "spec": [ + { + "type": "text", + "text": "CDP event name." + } + ], "required": true, - "comment": "", - "deprecated": false, + "comment": "CDP event name.", "async": false, - "alias": "httpCredentials", + "alias": "eventName", "overloadIndex": 0, "paramOrOption": null } ] + } + ] + }, + { + "name": "CDPSessionEvent", + "spec": [ + { + "type": "text", + "text": "`CDPSessionEvent` objects are returned by page via the [`method: CDPSession.event`] method." }, { - "kind": "method", - "langs": {}, + "type": "text", + "text": "Each object represents a named event and allows handling of the event when it is raised." + } + ], + "langs": { + "only": [ + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "comment": "`CDPSessionEvent` objects are returned by page via the [`method: CDPSession.event`] method.\n\nEach object represents a named event and allows handling of the event when it is raised.", + "since": "v1.30", + "members": [ + { + "kind": "event", + "langs": { + "only": [ + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, - "since": "v1.8", - "name": "setOffline", + "since": "v1.30", + "name": "onEvent", "type": { - "name": "void" + "name": "JsonElement?", + "expression": "[JsonElement?]" }, "spec": [], "required": true, "comment": "", - "deprecated": false, - "async": true, - "alias": "setOffline", + "async": false, + "alias": "onEvent", "overloadIndex": 0, "paramOrOption": null, - "args": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "offline", - "type": { - "name": "boolean", - "expression": "[boolean]" - }, - "spec": [ - { - "type": "text", - "text": "Whether to emulate network being offline for the browser context." - } - ], - "required": true, - "comment": "Whether to emulate network being offline for the browser context.", - "deprecated": false, - "async": false, - "alias": "offline", - "overloadIndex": 0, - "paramOrOption": null - } - ] + "args": [] }, { - "kind": "method", + "kind": "property", "langs": { - "types": { - "csharp": { - "name": "string", - "expression": "[string]" - }, - "java": { - "name": "string", - "expression": "[string]" - } - } + "only": [ + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} }, "experimental": false, - "since": "v1.8", - "name": "storageState", + "since": "1.30", + "name": "eventName", "type": { - "name": "Object", - "properties": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "cookies", - "type": { - "name": "Array", - "templates": [ - { - "name": "Object", - "properties": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "name", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "" - } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "name", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "value", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "" - } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "value", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "domain", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "" - } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "domain", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "path", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "" - } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "path", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "expires", - "type": { - "name": "float", - "expression": "[float]" - }, - "spec": [ - { - "type": "text", - "text": "Unix time in seconds." - } - ], - "required": true, - "comment": "Unix time in seconds.", - "deprecated": false, - "async": false, - "alias": "expires", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "httpOnly", - "type": { - "name": "boolean", - "expression": "[boolean]" - }, - "spec": [ - { - "type": "text", - "text": "" - } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "httpOnly", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "secure", - "type": { - "name": "boolean", - "expression": "[boolean]" - }, - "spec": [ - { - "type": "text", - "text": "" - } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "secure", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "sameSite", - "type": { - "name": "SameSiteAttribute", - "union": [ - { - "name": "\"Strict\"" - }, - { - "name": "\"Lax\"" - }, - { - "name": "\"None\"" - } - ], - "expression": "[SameSiteAttribute]<\"Strict\"|\"Lax\"|\"None\">" - }, - "spec": [ - { - "type": "text", - "text": "" - } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "sameSite", - "overloadIndex": 0, - "paramOrOption": null - } - ] - } - ], - "expression": "[Array]<[Object]>" + "name": "string", + "expression": "[string]" + }, + "spec": [], + "required": true, + "comment": "", + "async": false, + "alias": "eventName", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + } + ] + }, + { + "name": "ConsoleMessage", + "spec": [ + { + "type": "text", + "text": "`ConsoleMessage` objects are dispatched by page via the [`event: Page.console`] event.↵For each console messages logged in the page there will be corresponding event in the Playwright↵context." + }, + { + "type": "code", + "lines": [ + "// Listen for all console logs", + "page.on('console', msg => console.log(msg.text()))", + "", + "// Listen for all console events and handle errors", + "page.on('console', msg => {", + " if (msg.type() === 'error')", + " console.log(`Error text: \"${msg.text()}\"`);", + "});", + "", + "// Get the next console log", + "const msgPromise = page.waitForEvent('console');", + "await page.evaluate(() => {", + " console.log('hello', 42, { foo: 'bar' }); // Issue console.log inside the page", + "});", + "const msg = await msgPromise;", + "", + "// Deconstruct console log arguments", + "await msg.args[0].jsonValue() // hello", + "await msg.args[1].jsonValue() // 42" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "// Listen for all console messages and print them to the standard output.", + "page.onConsoleMessage(msg -> System.out.println(msg.text()));", + "", + "// Listen for all console messages and print errors to the standard output.", + "page.onConsoleMessage(msg -> {", + " if (\"error\".equals(msg.type()))", + " System.out.println(\"Error text: \" + msg.text());", + "});", + "", + "// Get the next console message", + "ConsoleMessage msg = page.waitForConsoleMessage(() -> {", + " // Issue console.log inside the page", + " page.evaluate(\"console.log('hello', 42, { foo: 'bar' });\");", + "});", + "", + "// Deconstruct console.log arguments", + "msg.args().get(0).jsonValue() // hello", + "msg.args().get(1).jsonValue() // 42" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "# Listen for all console logs", + "page.on(\"console\", lambda msg: print(msg.text))", + "", + "# Listen for all console events and handle errors", + "page.on(\"console\", lambda msg: print(f\"error: {msg.text}\") if msg.type == \"error\" else None)", + "", + "# Get the next console log", + "async with page.expect_console_message() as msg_info:", + " # Issue console.log inside the page", + " await page.evaluate(\"console.log('hello', 42, { foo: 'bar' })\")", + "msg = await msg_info.value", + "", + "# Deconstruct print arguments", + "await msg.args[0].json_value() # hello", + "await msg.args[1].json_value() # 42" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "# Listen for all console logs", + "page.on(\"console\", lambda msg: print(msg.text))", + "", + "# Listen for all console events and handle errors", + "page.on(\"console\", lambda msg: print(f\"error: {msg.text}\") if msg.type == \"error\" else None)", + "", + "# Get the next console log", + "with page.expect_console_message() as msg_info:", + " # Issue console.log inside the page", + " page.evaluate(\"console.log('hello', 42, { foo: 'bar' })\")", + "msg = msg_info.value", + "", + "# Deconstruct print arguments", + "msg.args[0].json_value() # hello", + "msg.args[1].json_value() # 42" + ], + "codeLang": "python sync" + }, + { + "type": "code", + "lines": [ + "// Listen for all console messages and print them to the standard output.", + "page.Console += (_, msg) => Console.WriteLine(msg.Text);", + "", + "// Listen for all console messages and print errors to the standard output.", + "page.Console += (_, msg) =>", + "{", + " if (\"error\".Equals(msg.Type))", + " Console.WriteLine(\"Error text: \" + msg.Text);", + "};", + "", + "// Get the next console message", + "var waitForMessageTask = page.WaitForConsoleMessageAsync();", + "await page.EvaluateAsync(\"console.log('hello', 42, { foo: 'bar' });\");", + "var message = await waitForMessageTask;", + "// Deconstruct console.log arguments", + "await message.Args.ElementAt(0).JsonValueAsync(); // hello", + "await message.Args.ElementAt(1).JsonValueAsync(); // 42" + ], + "codeLang": "csharp" + } + ], + "langs": {}, + "comment": "`ConsoleMessage` objects are dispatched by page via the [`event: Page.console`] event. For each console messages\nlogged in the page there will be corresponding event in the Playwright context.\n\n```js\n// Listen for all console logs\npage.on('console', msg => console.log(msg.text()))\n\n// Listen for all console events and handle errors\npage.on('console', msg => {\n if (msg.type() === 'error')\n console.log(`Error text: \"${msg.text()}\"`);\n});\n\n// Get the next console log\nconst msgPromise = page.waitForEvent('console');\nawait page.evaluate(() => {\n console.log('hello', 42, { foo: 'bar' }); // Issue console.log inside the page\n});\nconst msg = await msgPromise;\n\n// Deconstruct console log arguments\nawait msg.args[0].jsonValue() // hello\nawait msg.args[1].jsonValue() // 42\n```\n\n```java\n// Listen for all console messages and print them to the standard output.\npage.onConsoleMessage(msg -> System.out.println(msg.text()));\n\n// Listen for all console messages and print errors to the standard output.\npage.onConsoleMessage(msg -> {\n if (\"error\".equals(msg.type()))\n System.out.println(\"Error text: \" + msg.text());\n});\n\n// Get the next console message\nConsoleMessage msg = page.waitForConsoleMessage(() -> {\n // Issue console.log inside the page\n page.evaluate(\"console.log('hello', 42, { foo: 'bar' });\");\n});\n\n// Deconstruct console.log arguments\nmsg.args().get(0).jsonValue() // hello\nmsg.args().get(1).jsonValue() // 42\n```\n\n```py\n# Listen for all console logs\npage.on(\"console\", lambda msg: print(msg.text))\n\n# Listen for all console events and handle errors\npage.on(\"console\", lambda msg: print(f\"error: {msg.text}\") if msg.type == \"error\" else None)\n\n# Get the next console log\nasync with page.expect_console_message() as msg_info:\n # Issue console.log inside the page\n await page.evaluate(\"console.log('hello', 42, { foo: 'bar' })\")\nmsg = await msg_info.value\n\n# Deconstruct print arguments\nawait msg.args[0].json_value() # hello\nawait msg.args[1].json_value() # 42\n```\n\n```py\n# Listen for all console logs\npage.on(\"console\", lambda msg: print(msg.text))\n\n# Listen for all console events and handle errors\npage.on(\"console\", lambda msg: print(f\"error: {msg.text}\") if msg.type == \"error\" else None)\n\n# Get the next console log\nwith page.expect_console_message() as msg_info:\n # Issue console.log inside the page\n page.evaluate(\"console.log('hello', 42, { foo: 'bar' })\")\nmsg = msg_info.value\n\n# Deconstruct print arguments\nmsg.args[0].json_value() # hello\nmsg.args[1].json_value() # 42\n```\n\n```csharp\n// Listen for all console messages and print them to the standard output.\npage.Console += (_, msg) => Console.WriteLine(msg.Text);\n\n// Listen for all console messages and print errors to the standard output.\npage.Console += (_, msg) =>\n{\n if (\"error\".Equals(msg.Type))\n Console.WriteLine(\"Error text: \" + msg.Text);\n};\n\n// Get the next console message\nvar waitForMessageTask = page.WaitForConsoleMessageAsync();\nawait page.EvaluateAsync(\"console.log('hello', 42, { foo: 'bar' });\");\nvar message = await waitForMessageTask;\n// Deconstruct console.log arguments\nawait message.Args.ElementAt(0).JsonValueAsync(); // hello\nawait message.Args.ElementAt(1).JsonValueAsync(); // 42\n```\n", + "since": "v1.8", + "members": [ + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "args", + "type": { + "name": "Array", + "templates": [ + { + "name": "JSHandle" + } + ], + "expression": "[Array]<[JSHandle]>" + }, + "spec": [ + { + "type": "text", + "text": "List of arguments passed to a `console` function call. See also [`event: Page.console`]." + } + ], + "required": true, + "comment": "List of arguments passed to a `console` function call. See also [`event: Page.console`].", + "async": false, + "alias": "args", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": { + "only": [ + "js", + "python" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "location", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "url", + "type": { + "name": "string", + "expression": "[string]" }, "spec": [ { "type": "text", - "text": "" + "text": "URL of the resource." } ], "required": true, - "comment": "", - "deprecated": false, + "comment": "URL of the resource.", "async": false, - "alias": "cookies", + "alias": "url", "overloadIndex": 0, "paramOrOption": null }, @@ -22543,213 +31051,111 @@ "langs": {}, "experimental": false, "since": "v1.0", - "name": "origins", + "name": "lineNumber", "type": { - "name": "Array", - "templates": [ - { - "name": "Object", - "properties": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "origin", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "" - } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "origin", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "localStorage", - "type": { - "name": "Array", - "templates": [ - { - "name": "Object", - "properties": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "name", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "" - } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "name", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "value", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "" - } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "value", - "overloadIndex": 0, - "paramOrOption": null - } - ] - } - ], - "expression": "[Array]<[Object]>" - }, - "spec": [ - { - "type": "text", - "text": "" - } - ], - "required": true, - "comment": "", - "deprecated": false, - "async": false, - "alias": "localStorage", - "overloadIndex": 0, - "paramOrOption": null - } - ] - } - ], - "expression": "[Array]<[Object]>" + "name": "int", + "expression": "[int]" }, "spec": [ { "type": "text", - "text": "" + "text": "0-based line number in the resource." } ], "required": true, - "comment": "", - "deprecated": false, + "comment": "0-based line number in the resource.", "async": false, - "alias": "origins", + "alias": "lineNumber", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "columnNumber", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "0-based column number in the resource." + } + ], + "required": true, + "comment": "0-based column number in the resource.", + "async": false, + "alias": "columnNumber", "overloadIndex": 0, "paramOrOption": null } ], "expression": "[Object]" }, + "spec": [], + "required": true, + "comment": "", + "async": false, + "alias": "location", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": { + "only": [ + "csharp", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "location", + "type": { + "name": "string", + "expression": "[string]" + }, "spec": [ { "type": "text", - "text": "Returns storage state for this browser context, contains current cookies and local storage snapshot." + "text": "URL of the resource followed by 0-based line and column numbers in the resource formatted as `URL:line:column`." } ], "required": true, - "comment": "Returns storage state for this browser context, contains current cookies and local storage snapshot.", - "deprecated": false, - "async": true, - "alias": "storageState", + "comment": "URL of the resource followed by 0-based line and column numbers in the resource formatted as `URL:line:column`.", + "async": false, + "alias": "location", "overloadIndex": 0, "paramOrOption": null, - "args": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "options", - "type": { - "name": "Object", - "properties": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "path", - "type": { - "name": "path", - "expression": "[path]" - }, - "spec": [ - { - "type": "text", - "text": "The file path to save the storage state to. If `path` is a relative path, then it is resolved relative to current working directory. If no path is provided, storage state is still returned, but won't be saved to the disk." - } - ], - "required": false, - "comment": "The file path to save the storage state to. If `path` is a relative path, then it is resolved relative to current\nworking directory. If no path is provided, storage state is still returned, but won't be saved to the disk.", - "deprecated": false, - "async": false, - "alias": "path", - "overloadIndex": 0, - "paramOrOption": null - } - ] - }, - "required": false, - "comment": "", - "deprecated": false, - "async": false, - "alias": "options", - "overloadIndex": 0, - "paramOrOption": null - } - ] + "args": [] }, { - "kind": "property", + "kind": "method", "langs": {}, "experimental": false, - "since": "v1.12", - "name": "tracing", + "since": "v1.8", + "name": "text", "type": { - "name": "Tracing", - "expression": "[Tracing]" + "name": "string", + "expression": "[string]" }, - "spec": [], + "spec": [ + { + "type": "text", + "text": "The text of the console message." + } + ], "required": true, - "comment": "", - "deprecated": false, + "comment": "The text of the console message.", "async": false, - "alias": "tracing", + "alias": "text", "overloadIndex": 0, "paramOrOption": null, "args": [] @@ -22759,345 +31165,100 @@ "langs": {}, "experimental": false, "since": "v1.8", - "name": "unroute", + "name": "type", "type": { - "name": "void" + "name": "string", + "expression": "[string]" }, "spec": [ { "type": "text", - "text": "Removes a route created with [`method: BrowserContext.route`]. When `handler` is not specified, removes all routes for the `url`." + "text": "One of the following values: `'log'`, `'debug'`, `'info'`, `'error'`, `'warning'`, `'dir'`, `'dirxml'`, `'table'`,↵`'trace'`, `'clear'`, `'startGroup'`, `'startGroupCollapsed'`, `'endGroup'`, `'assert'`, `'profile'`, `'profileEnd'`,↵`'count'`, `'timeEnd'`." } ], "required": true, - "comment": "Removes a route created with [`method: BrowserContext.route`]. When `handler` is not specified, removes all routes for\nthe `url`.", - "deprecated": false, - "async": true, - "alias": "unroute", + "comment": "One of the following values: `'log'`, `'debug'`, `'info'`, `'error'`, `'warning'`, `'dir'`, `'dirxml'`, `'table'`,\n`'trace'`, `'clear'`, `'startGroup'`, `'startGroupCollapsed'`, `'endGroup'`, `'assert'`, `'profile'`,\n`'profileEnd'`, `'count'`, `'timeEnd'`.", + "async": false, + "alias": "type", "overloadIndex": 0, "paramOrOption": null, - "args": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "url", - "type": { - "name": "", - "union": [ - { - "name": "string" - }, - { - "name": "RegExp" - }, - { - "name": "function", - "args": [ - { - "name": "URL" - } - ], - "returnType": { - "name": "boolean" - } - } - ], - "expression": "[string]|[RegExp]|[function]([URL]):[boolean]" - }, - "spec": [ - { - "type": "text", - "text": "A glob pattern, regex pattern or predicate receiving [URL] used to register a routing with [`method: BrowserContext.route`]." - } - ], - "required": true, - "comment": "A glob pattern, regex pattern or predicate receiving [URL] used to register a routing with\n[`method: BrowserContext.route`].", - "deprecated": false, - "async": false, - "alias": "url", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": { - "only": [ - "js", - "python" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.8", - "name": "handler", - "type": { - "name": "function", - "args": [ - { - "name": "Route" - }, - { - "name": "Request" - } - ], - "returnType": null, - "expression": "[function]([Route], [Request])" - }, - "spec": [ - { - "type": "text", - "text": "Optional handler function used to register a routing with [`method: BrowserContext.route`]." - } - ], - "required": false, - "comment": "Optional handler function used to register a routing with [`method: BrowserContext.route`].", - "deprecated": false, - "async": false, - "alias": "handler", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": { - "only": [ - "csharp", - "java" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.8", - "name": "handler", - "type": { - "name": "function", - "args": [ - { - "name": "Route" - } - ], - "returnType": null, - "expression": "[function]([Route])" - }, - "spec": [ - { - "type": "text", - "text": "Optional handler function used to register a routing with [`method: BrowserContext.route`]." - } - ], - "required": false, - "comment": "Optional handler function used to register a routing with [`method: BrowserContext.route`].", - "deprecated": false, - "async": false, - "alias": "handler", - "overloadIndex": 0, - "paramOrOption": null - } - ] + "args": [] + } + ] + }, + { + "name": "Coverage", + "spec": [ + { + "type": "text", + "text": "Coverage gathers information about parts of JavaScript and CSS that were used by the page." + }, + { + "type": "text", + "text": "An example of using JavaScript coverage to produce Istanbul report for page load:" + }, + { + "type": "note", + "noteType": "note", + "text": "Coverage APIs are only supported on Chromium-based browsers." }, + { + "type": "code", + "lines": [ + "const { chromium } = require('playwright');", + "const v8toIstanbul = require('v8-to-istanbul');", + "", + "(async() => {", + " const browser = await chromium.launch();", + " const page = await browser.newPage();", + " await page.coverage.startJSCoverage();", + " await page.goto('https://chromium.org');", + " const coverage = await page.coverage.stopJSCoverage();", + " for (const entry of coverage) {", + " const converter = v8toIstanbul('', 0, { source: entry.source });", + " await converter.load();", + " converter.applyCoverage(entry.functions);", + " console.log(JSON.stringify(converter.toIstanbul()));", + " }", + " await browser.close();", + "})();" + ], + "codeLang": "js" + } + ], + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "comment": "Coverage gathers information about parts of JavaScript and CSS that were used by the page.\n\nAn example of using JavaScript coverage to produce Istanbul report for page load:\n\n**NOTE** Coverage APIs are only supported on Chromium-based browsers.\n\n```js\nconst { chromium } = require('playwright');\nconst v8toIstanbul = require('v8-to-istanbul');\n\n(async() => {\n const browser = await chromium.launch();\n const page = await browser.newPage();\n await page.coverage.startJSCoverage();\n await page.goto('https://chromium.org');\n const coverage = await page.coverage.stopJSCoverage();\n for (const entry of coverage) {\n const converter = v8toIstanbul('', 0, { source: entry.source });\n await converter.load();\n converter.applyCoverage(entry.functions);\n console.log(JSON.stringify(converter.toIstanbul()));\n }\n await browser.close();\n})();\n```\n", + "since": "v1.11", + "members": [ { "kind": "method", - "langs": { - "only": [ - "js", - "python" - ], - "aliases": { - "python": "expect_event" - }, - "types": { - "python": { - "name": "EventContextManager", - "expression": "[EventContextManager]" - } - }, - "overrides": {} - }, + "langs": {}, "experimental": false, - "since": "v1.8", - "name": "waitForEvent", + "since": "v1.11", + "name": "startCSSCoverage", "type": { - "name": "any", - "expression": "[any]" + "name": "void" }, "spec": [ { "type": "text", - "text": "Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy value. Will throw an error if the context closes before the event is fired. Returns the event data value." - }, - { - "type": "code", - "lines": [ - "const [page, _] = await Promise.all([", - " context.waitForEvent('page'),", - " page.locator('button').click()", - "]);" - ], - "codeLang": "js" - }, - { - "type": "code", - "lines": [ - "Page newPage = context.waitForPage(() -> page.locator(\"button\").click());" - ], - "codeLang": "java" - }, - { - "type": "code", - "lines": [ - "async with context.expect_event(\"page\") as event_info:", - " await page.locator(\"button\").click()", - "page = await event_info.value" - ], - "codeLang": "python async" - }, - { - "type": "code", - "lines": [ - "with context.expect_event(\"page\") as event_info:", - " page.locator(\"button\").click()", - "page = event_info.value" - ], - "codeLang": "python sync" - }, - { - "type": "code", - "lines": [ - "var page = await context.RunAndWaitForPageAsync(async () =>", - "{", - " await page.Locator(\"button\").ClickAsync();", - "});" - ], - "codeLang": "csharp" + "text": "Returns coverage is started" } ], "required": true, - "comment": "Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy\nvalue. Will throw an error if the context closes before the event is fired. Returns the event data value.\n\n```js\nconst [page, _] = await Promise.all([\n context.waitForEvent('page'),\n page.locator('button').click()\n]);\n```\n\n```java\nPage newPage = context.waitForPage(() -> page.locator(\"button\").click());\n```\n\n```python async\nasync with context.expect_event(\"page\") as event_info:\n await page.locator(\"button\").click()\npage = await event_info.value\n```\n\n```python sync\nwith context.expect_event(\"page\") as event_info:\n page.locator(\"button\").click()\npage = event_info.value\n```\n\n```csharp\nvar page = await context.RunAndWaitForPageAsync(async () =>\n{\n await page.Locator(\"button\").ClickAsync();\n});\n```\n", - "deprecated": false, + "comment": "Returns coverage is started", "async": true, - "alias": "waitForEvent", + "alias": "startCSSCoverage", "overloadIndex": 0, "paramOrOption": null, "args": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "event", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "Event name, same one would pass into `browserContext.on(event)`." - } - ], - "required": true, - "comment": "Event name, same one would pass into `browserContext.on(event)`.", - "deprecated": false, - "async": false, - "alias": "event", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": { - "only": [ - "js" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.8", - "name": "optionsOrPredicate", - "type": { - "name": "", - "union": [ - { - "name": "function" - }, - { - "name": "Object", - "properties": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "predicate", - "type": { - "name": "function", - "expression": "[function]" - }, - "spec": [ - { - "type": "text", - "text": "receives the event data and resolves to truthy value when the waiting should resolve." - } - ], - "required": true, - "comment": "receives the event data and resolves to truthy value when the waiting should resolve.", - "deprecated": false, - "async": false, - "alias": "predicate", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "timeout", - "type": { - "name": "float", - "expression": "[float]" - }, - "spec": [ - { - "type": "text", - "text": "maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [`method: BrowserContext.setDefaultTimeout`]." - } - ], - "required": false, - "comment": "maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default\nvalue can be changed by using the [`method: BrowserContext.setDefaultTimeout`].", - "deprecated": false, - "async": false, - "alias": "timeout", - "overloadIndex": 0, - "paramOrOption": null - } - ] - } - ], - "expression": "[function]|[Object]" - }, - "spec": [ - { - "type": "text", - "text": "Either a predicate that receives an event or an options object. Optional." - } - ], - "required": false, - "comment": "Either a predicate that receives an event or an options object. Optional.", - "deprecated": false, - "async": false, - "alias": "optionsOrPredicate", - "overloadIndex": 0, - "paramOrOption": null - }, { "kind": "property", "langs": {}, @@ -23111,56 +31272,22 @@ "kind": "property", "langs": {}, "experimental": false, - "since": "v1.8", - "name": "predicate", - "type": { - "name": "function", - "expression": "[function]" - }, - "spec": [ - { - "type": "text", - "text": "Receives the event data and resolves to truthy value when the waiting should resolve." - } - ], - "required": false, - "comment": "Receives the event data and resolves to truthy value when the waiting should resolve.", - "deprecated": false, - "async": false, - "alias": "predicate", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": { - "only": [ - "csharp", - "java", - "python" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.8", - "name": "timeout", + "since": "v1.11", + "name": "resetOnNavigation", "type": { - "name": "float", - "expression": "[float]" + "name": "boolean", + "expression": "[boolean]" }, "spec": [ { "type": "text", - "text": "Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [`method: BrowserContext.setDefaultTimeout`]." + "text": "Whether to reset coverage on every navigation. Defaults to `true`." } ], "required": false, - "comment": "Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default\nvalue can be changed by using the [`method: BrowserContext.setDefaultTimeout`].", - "deprecated": false, + "comment": "Whether to reset coverage on every navigation. Defaults to `true`.", "async": false, - "alias": "timeout", + "alias": "resetOnNavigation", "overloadIndex": 0, "paramOrOption": null } @@ -23168,7 +31295,6 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, @@ -23178,47 +31304,28 @@ }, { "kind": "method", - "langs": { - "only": [ - "java", - "python", - "csharp" - ], - "aliases": { - "python": "expect_page", - "csharp": "RunAndWaitForPage" - }, - "types": { - "python": { - "name": "EventContextManager", - "templates": [ - { - "name": "Page" - } - ], - "expression": "[EventContextManager]<[Page]>" - } - }, - "overrides": {} - }, + "langs": {}, "experimental": false, - "since": "v1.9", - "name": "waitForPage", + "since": "v1.11", + "name": "startJSCoverage", "type": { - "name": "Page", - "expression": "[Page]" + "name": "void" }, "spec": [ { "type": "text", - "text": "Performs action and waits for a new `Page` to be created in the context. If predicate is provided, it passes `Page` value into the `predicate` function and waits for `predicate(event)` to return a truthy value. Will throw an error if the context closes before new `Page` is created." + "text": "Returns coverage is started" + }, + { + "type": "note", + "noteType": "note", + "text": "Anonymous scripts are ones that don't have an associated url. These are scripts that are dynamically created↵on the page using `eval` or `new Function`. If `reportAnonymousScripts` is set to `true`, anonymous scripts↵will have `__playwright_evaluation_script__` as their URL." } ], "required": true, - "comment": "Performs action and waits for a new `Page` to be created in the context. If predicate is provided, it passes `Page`\nvalue into the `predicate` function and waits for `predicate(event)` to return a truthy value. Will throw an error if\nthe context closes before new `Page` is created.", - "deprecated": false, + "comment": "Returns coverage is started\n\n**NOTE** Anonymous scripts are ones that don't have an associated url. These are scripts that are dynamically\ncreated on the page using `eval` or `new Function`. If `reportAnonymousScripts` is set to `true`, anonymous scripts\nwill have `__playwright_evaluation_script__` as their URL.", "async": true, - "alias": "waitForPage", + "alias": "startJSCoverage", "overloadIndex": 0, "paramOrOption": null, "args": [ @@ -23233,75 +31340,47 @@ "properties": [ { "kind": "property", - "langs": { - "only": [ - "csharp", - "java", - "python" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, + "langs": {}, "experimental": false, - "since": "v1.9", - "name": "predicate", + "since": "v1.11", + "name": "reportAnonymousScripts", "type": { - "name": "function", - "args": [ - { - "name": "Page" - } - ], - "returnType": { - "name": "boolean" - }, - "expression": "[function]([Page]):[boolean]" + "name": "boolean", + "expression": "[boolean]" }, "spec": [ { "type": "text", - "text": "Receives the `Page` object and resolves to truthy value when the waiting should resolve." + "text": "Whether anonymous scripts generated by the page should be reported. Defaults to `false`." } ], "required": false, - "comment": "Receives the `Page` object and resolves to truthy value when the waiting should resolve.", - "deprecated": false, + "comment": "Whether anonymous scripts generated by the page should be reported. Defaults to `false`.", "async": false, - "alias": "predicate", + "alias": "reportAnonymousScripts", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": { - "only": [ - "csharp", - "java", - "python" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, + "langs": {}, "experimental": false, - "since": "v1.9", - "name": "timeout", + "since": "v1.11", + "name": "resetOnNavigation", "type": { - "name": "float", - "expression": "[float]" + "name": "boolean", + "expression": "[boolean]" }, "spec": [ { "type": "text", - "text": "Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [`method: BrowserContext.setDefaultTimeout`]." + "text": "Whether to reset coverage on every navigation. Defaults to `true`." } ], "required": false, - "comment": "Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default\nvalue can be changed by using the [`method: BrowserContext.setDefaultTimeout`].", - "deprecated": false, + "comment": "Whether to reset coverage on every navigation. Defaults to `true`.", "async": false, - "alias": "timeout", + "alias": "resetOnNavigation", "overloadIndex": 0, "paramOrOption": null } @@ -23309,288 +31388,655 @@ }, "required": false, "comment": "", - "deprecated": false, "async": false, "alias": "options", "overloadIndex": 0, "paramOrOption": null - }, - { - "kind": "property", - "langs": { - "only": [ - "csharp" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.12", - "name": "action", - "type": { - "name": "Func", - "templates": [ - { - "name": "Task" - } - ], - "expression": "[Func]" - }, - "spec": [ - { - "type": "text", - "text": "Action that triggers the event." - } - ], - "required": true, - "comment": "Action that triggers the event.", - "deprecated": false, - "async": false, - "alias": "action", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": { - "only": [ - "java" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.9", - "name": "callback", - "type": { - "name": "Runnable", - "expression": "[Runnable]" - }, - "spec": [ - { - "type": "text", - "text": "Callback that performs the action triggering the event." - } - ], - "required": true, - "comment": "Callback that performs the action triggering the event.", - "deprecated": false, - "async": false, - "alias": "callback", - "overloadIndex": 0, - "paramOrOption": null } ] }, { "kind": "method", - "langs": { - "only": [ - "python" - ], - "aliases": { - "python": "wait_for_event" - }, - "types": {}, - "overrides": {} - }, + "langs": {}, "experimental": false, - "since": "v1.8", - "name": "waitForEvent2", + "since": "v1.11", + "name": "stopCSSCoverage", "type": { - "name": "any", - "expression": "[any]" + "name": "Array", + "templates": [ + { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "url", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "StyleSheet URL" + } + ], + "required": true, + "comment": "StyleSheet URL", + "async": false, + "alias": "url", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "text", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "StyleSheet content, if available." + } + ], + "required": false, + "comment": "StyleSheet content, if available.", + "async": false, + "alias": "text", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "ranges", + "type": { + "name": "Array", + "templates": [ + { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "start", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "A start offset in text, inclusive" + } + ], + "required": true, + "comment": "A start offset in text, inclusive", + "async": false, + "alias": "start", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "end", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "An end offset in text, exclusive" + } + ], + "required": true, + "comment": "An end offset in text, exclusive", + "async": false, + "alias": "end", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ], + "expression": "[Array]<[Object]>" + }, + "spec": [ + { + "type": "text", + "text": "StyleSheet ranges that were used. Ranges are sorted and non-overlapping." + } + ], + "required": true, + "comment": "StyleSheet ranges that were used. Ranges are sorted and non-overlapping.", + "async": false, + "alias": "ranges", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ], + "expression": "[Array]<[Object]>" }, "spec": [ { - "type": "note", - "noteType": "note", - "text": "In most cases, you should use [`method: BrowserContext.waitForEvent`]." + "type": "text", + "text": "Returns the array of coverage reports for all stylesheets" }, { - "type": "text", - "text": "Waits for given `event` to fire. If predicate is provided, it passes event's value into the `predicate` function and waits for `predicate(event)` to return a truthy value. Will throw an error if the browser context is closed before the `event` is fired." + "type": "note", + "noteType": "note", + "text": "CSS Coverage doesn't include dynamically injected style tags without sourceURLs." } ], "required": true, - "comment": "> NOTE: In most cases, you should use [`method: BrowserContext.waitForEvent`].\n\nWaits for given `event` to fire. If predicate is provided, it passes event's value into the `predicate` function and\nwaits for `predicate(event)` to return a truthy value. Will throw an error if the browser context is closed before the\n`event` is fired.", - "deprecated": false, + "comment": "Returns the array of coverage reports for all stylesheets\n\n**NOTE** CSS Coverage doesn't include dynamically injected style tags without sourceURLs.", "async": true, - "alias": "waitForEvent2", + "alias": "stopCSSCoverage", "overloadIndex": 0, "paramOrOption": null, - "args": [ - { - "kind": "property", - "langs": { - "only": [ - "js", - "python", - "java" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.8", - "name": "event", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "Event name, same one typically passed into `*.on(event)`." - } - ], - "required": true, - "comment": "Event name, same one typically passed into `*.on(event)`.", - "deprecated": false, - "async": false, - "alias": "event", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "options", - "type": { + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.11", + "name": "stopJSCoverage", + "type": { + "name": "Array", + "templates": [ + { "name": "Object", "properties": [ { "kind": "property", "langs": {}, "experimental": false, - "since": "v1.8", - "name": "predicate", + "since": "v1.0", + "name": "url", "type": { - "name": "function", - "expression": "[function]" + "name": "string", + "expression": "[string]" }, "spec": [ { "type": "text", - "text": "Receives the event data and resolves to truthy value when the waiting should resolve." + "text": "Script URL" } ], - "required": false, - "comment": "Receives the event data and resolves to truthy value when the waiting should resolve.", - "deprecated": false, + "required": true, + "comment": "Script URL", "async": false, - "alias": "predicate", + "alias": "url", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": { - "only": [ - "csharp", - "java", - "python" - ], - "aliases": {}, - "types": {}, - "overrides": {} + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "scriptId", + "type": { + "name": "string", + "expression": "[string]" }, + "spec": [ + { + "type": "text", + "text": "Script ID" + } + ], + "required": true, + "comment": "Script ID", + "async": false, + "alias": "scriptId", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, "experimental": false, - "since": "v1.8", - "name": "timeout", + "since": "v1.0", + "name": "source", "type": { - "name": "float", - "expression": "[float]" + "name": "string", + "expression": "[string]" }, "spec": [ { "type": "text", - "text": "Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [`method: BrowserContext.setDefaultTimeout`]." + "text": "Script content, if applicable." } ], "required": false, - "comment": "Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default\nvalue can be changed by using the [`method: BrowserContext.setDefaultTimeout`].", - "deprecated": false, + "comment": "Script content, if applicable.", "async": false, - "alias": "timeout", + "alias": "source", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "functions", + "type": { + "name": "Array", + "templates": [ + { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "functionName", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "functionName", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "isBlockCoverage", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "isBlockCoverage", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "ranges", + "type": { + "name": "Array", + "templates": [ + { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "count", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "count", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "startOffset", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "startOffset", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "endOffset", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "endOffset", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ], + "expression": "[Array]<[Object]>" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "ranges", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ], + "expression": "[Array]<[Object]>" + }, + "spec": [ + { + "type": "text", + "text": "V8-specific coverage format." + } + ], + "required": true, + "comment": "V8-specific coverage format.", + "async": false, + "alias": "functions", "overloadIndex": 0, "paramOrOption": null } ] - }, - "required": false, - "comment": "", - "deprecated": false, - "async": false, - "alias": "options", - "overloadIndex": 0, - "paramOrOption": null + } + ], + "expression": "[Array]<[Object]>" + }, + "spec": [ + { + "type": "text", + "text": "Returns the array of coverage reports for all scripts" + }, + { + "type": "note", + "noteType": "note", + "text": "JavaScript Coverage doesn't include anonymous scripts by default. However, scripts with sourceURLs are↵reported." } - ] + ], + "required": true, + "comment": "Returns the array of coverage reports for all scripts\n\n**NOTE** JavaScript Coverage doesn't include anonymous scripts by default. However, scripts with sourceURLs are\nreported.", + "async": true, + "alias": "stopJSCoverage", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] } ] }, { - "name": "BrowserServer", - "spec": [], - "langs": { - "only": [ - "js" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, + "name": "Dialog", + "spec": [ + { + "type": "text", + "text": "`Dialog` objects are dispatched by page via the [`event: Page.dialog`] event." + }, + { + "type": "text", + "text": "An example of using `Dialog` class:" + }, + { + "type": "code", + "lines": [ + "const { chromium } = require('playwright'); // Or 'firefox' or 'webkit'.", + "", + "(async () => {", + " const browser = await chromium.launch();", + " const page = await browser.newPage();", + " page.on('dialog', async dialog => {", + " console.log(dialog.message());", + " await dialog.dismiss();", + " });", + " await page.evaluate(() => alert('1'));", + " await browser.close();", + "})();" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "import com.microsoft.playwright.*;", + "", + "public class Example {", + " public static void main(String[] args) {", + " try (Playwright playwright = Playwright.create()) {", + " BrowserType chromium = playwright.chromium();", + " Browser browser = chromium.launch();", + " Page page = browser.newPage();", + " page.onDialog(dialog -> {", + " System.out.println(dialog.message());", + " dialog.dismiss();", + " });", + " page.evaluate(\"alert('1')\");", + " browser.close();", + " }", + " }", + "}" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "import asyncio", + "from playwright.async_api import async_playwright", + "", + "async def handle_dialog(dialog):", + " print(dialog.message)", + " await dialog.dismiss()", + "", + "async def run(playwright):", + " chromium = playwright.chromium", + " browser = await chromium.launch()", + " page = await browser.new_page()", + " page.on(\"dialog\", handle_dialog)", + " page.evaluate(\"alert('1')\")", + " await browser.close()", + "", + "async def main():", + " async with async_playwright() as playwright:", + " await run(playwright)", + "asyncio.run(main())" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "from playwright.sync_api import sync_playwright", + "", + "def handle_dialog(dialog):", + " print(dialog.message)", + " dialog.dismiss()", + "", + "def run(playwright):", + " chromium = playwright.chromium", + " browser = chromium.launch()", + " page = browser.new_page()", + " page.on(\"dialog\", handle_dialog)", + " page.evaluate(\"alert('1')\")", + " browser.close()", + "", + "with sync_playwright() as playwright:", + " run(playwright)" + ], + "codeLang": "python sync" + }, + { + "type": "code", + "lines": [ + "using Microsoft.Playwright;", + "using System.Threading.Tasks;", + "", + "class DialogExample", + "{", + " public static async Task Run()", + " {", + " using var playwright = await Playwright.CreateAsync();", + " await using var browser = await playwright.Chromium.LaunchAsync();", + " var page = await browser.NewPageAsync();", + "", + " page.Dialog += async (_, dialog) =>", + " {", + " System.Console.WriteLine(dialog.Message);", + " await dialog.DismissAsync();", + " };", + "", + " await page.EvaluateAsync(\"alert('1');\");", + " }", + "}" + ], + "codeLang": "csharp" + }, + { + "type": "note", + "noteType": "note", + "text": "Dialogs are dismissed automatically, unless there is a [`event: Page.dialog`] listener.↵When listener is present, it **must** either [`method: Dialog.accept`] or [`method: Dialog.dismiss`] the dialog - otherwise the page will [freeze](https://developer.mozilla.org/en-US/docs/Web/JavaScript/EventLoop#never_blocking) waiting for the dialog, and actions like click will never finish." + } + ], + "langs": {}, + "comment": "`Dialog` objects are dispatched by page via the [`event: Page.dialog`] event.\n\nAn example of using `Dialog` class:\n\n```js\nconst { chromium } = require('playwright'); // Or 'firefox' or 'webkit'.\n\n(async () => {\n const browser = await chromium.launch();\n const page = await browser.newPage();\n page.on('dialog', async dialog => {\n console.log(dialog.message());\n await dialog.dismiss();\n });\n await page.evaluate(() => alert('1'));\n await browser.close();\n})();\n```\n\n```java\nimport com.microsoft.playwright.*;\n\npublic class Example {\n public static void main(String[] args) {\n try (Playwright playwright = Playwright.create()) {\n BrowserType chromium = playwright.chromium();\n Browser browser = chromium.launch();\n Page page = browser.newPage();\n page.onDialog(dialog -> {\n System.out.println(dialog.message());\n dialog.dismiss();\n });\n page.evaluate(\"alert('1')\");\n browser.close();\n }\n }\n}\n```\n\n```py\nimport asyncio\nfrom playwright.async_api import async_playwright\n\nasync def handle_dialog(dialog):\n print(dialog.message)\n await dialog.dismiss()\n\nasync def run(playwright):\n chromium = playwright.chromium\n browser = await chromium.launch()\n page = await browser.new_page()\n page.on(\"dialog\", handle_dialog)\n page.evaluate(\"alert('1')\")\n await browser.close()\n\nasync def main():\n async with async_playwright() as playwright:\n await run(playwright)\nasyncio.run(main())\n```\n\n```py\nfrom playwright.sync_api import sync_playwright\n\ndef handle_dialog(dialog):\n print(dialog.message)\n dialog.dismiss()\n\ndef run(playwright):\n chromium = playwright.chromium\n browser = chromium.launch()\n page = browser.new_page()\n page.on(\"dialog\", handle_dialog)\n page.evaluate(\"alert('1')\")\n browser.close()\n\nwith sync_playwright() as playwright:\n run(playwright)\n```\n\n```csharp\nusing Microsoft.Playwright;\nusing System.Threading.Tasks;\n\nclass DialogExample\n{\n public static async Task Run()\n {\n using var playwright = await Playwright.CreateAsync();\n await using var browser = await playwright.Chromium.LaunchAsync();\n var page = await browser.NewPageAsync();\n\n page.Dialog += async (_, dialog) =>\n {\n System.Console.WriteLine(dialog.Message);\n await dialog.DismissAsync();\n };\n\n await page.EvaluateAsync(\"alert('1');\");\n }\n}\n```\n\n**NOTE** Dialogs are dismissed automatically, unless there is a [`event: Page.dialog`] listener. When listener is\npresent, it **must** either [`method: Dialog.accept`] or [`method: Dialog.dismiss`] the dialog - otherwise the page\nwill [freeze](https://developer.mozilla.org/en-US/docs/Web/JavaScript/EventLoop#never_blocking) waiting for the\ndialog, and actions like click will never finish.", + "since": "v1.8", "members": [ { - "kind": "event", + "kind": "method", "langs": {}, "experimental": false, "since": "v1.8", - "name": "close", + "name": "accept", "type": { "name": "void" }, "spec": [ { "type": "text", - "text": "Emitted when the browser server closes." + "text": "Returns when the dialog has been accepted." } ], "required": true, - "comment": "Emitted when the browser server closes.", - "deprecated": false, - "async": false, - "alias": "close", + "comment": "Returns when the dialog has been accepted.", + "async": true, + "alias": "accept", "overloadIndex": 0, "paramOrOption": null, - "args": [] + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "promptText", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "A text to enter in prompt. Does not cause any effects if the dialog's `type` is not prompt. Optional." + } + ], + "required": false, + "comment": "A text to enter in prompt. Does not cause any effects if the dialog's `type` is not prompt. Optional.", + "async": false, + "alias": "promptText", + "overloadIndex": 0, + "paramOrOption": null + } + ] }, { "kind": "method", "langs": {}, "experimental": false, "since": "v1.8", - "name": "close", + "name": "defaultValue", "type": { - "name": "void" + "name": "string", + "expression": "[string]" }, "spec": [ { "type": "text", - "text": "Closes the browser gracefully and makes sure the process is terminated." + "text": "If dialog is prompt, returns default prompt value. Otherwise, returns empty string." } ], "required": true, - "comment": "Closes the browser gracefully and makes sure the process is terminated.", - "deprecated": false, - "async": true, - "alias": "close", + "comment": "If dialog is prompt, returns default prompt value. Otherwise, returns empty string.", + "async": false, + "alias": "defaultValue", "overloadIndex": 0, "paramOrOption": null, "args": [] @@ -23600,21 +32046,20 @@ "langs": {}, "experimental": false, "since": "v1.8", - "name": "kill", + "name": "dismiss", "type": { "name": "void" }, "spec": [ { "type": "text", - "text": "Kills the browser process and waits for the process to exit." + "text": "Returns when the dialog has been dismissed." } ], "required": true, - "comment": "Kills the browser process and waits for the process to exit.", - "deprecated": false, + "comment": "Returns when the dialog has been dismissed.", "async": true, - "alias": "kill", + "alias": "dismiss", "overloadIndex": 0, "paramOrOption": null, "args": [] @@ -23624,22 +32069,21 @@ "langs": {}, "experimental": false, "since": "v1.8", - "name": "process", + "name": "message", "type": { - "name": "ChildProcess", - "expression": "[ChildProcess]" + "name": "string", + "expression": "[string]" }, "spec": [ { "type": "text", - "text": "Spawned browser application process." + "text": "A message displayed in the dialog." } ], "required": true, - "comment": "Spawned browser application process.", - "deprecated": false, + "comment": "A message displayed in the dialog.", "async": false, - "alias": "process", + "alias": "message", "overloadIndex": 0, "paramOrOption": null, "args": [] @@ -23649,7 +32093,7 @@ "langs": {}, "experimental": false, "since": "v1.8", - "name": "wsEndpoint", + "name": "type", "type": { "name": "string", "expression": "[string]" @@ -23657,18 +32101,13 @@ "spec": [ { "type": "text", - "text": "Browser websocket url." - }, - { - "type": "text", - "text": "Browser websocket endpoint which can be used as an argument to [`method: BrowserType.connect`] to establish connection to the browser." + "text": "Returns dialog's type, can be one of `alert`, `beforeunload`, `confirm` or `prompt`." } ], "required": true, - "comment": "Browser websocket url.\n\nBrowser websocket endpoint which can be used as an argument to [`method: BrowserType.connect`] to establish connection\nto the browser.", - "deprecated": false, + "comment": "Returns dialog's type, can be one of `alert`, `beforeunload`, `confirm` or `prompt`.", "async": false, - "alias": "wsEndpoint", + "alias": "type", "overloadIndex": 0, "paramOrOption": null, "args": [] @@ -23676,533 +32115,166 @@ ] }, { - "name": "BrowserType", + "name": "Download", "spec": [ { "type": "text", - "text": "BrowserType provides methods to launch a specific browser instance or connect to an existing one. The following is a typical example of using Playwright to drive automation:" + "text": "`Download` objects are dispatched by page via the [`event: Page.download`] event." + }, + { + "type": "text", + "text": "All the downloaded files belonging to the browser context are deleted when the↵browser context is closed." + }, + { + "type": "text", + "text": "Download event is emitted once the download starts. Download path becomes available once download completes:" }, { "type": "code", "lines": [ - "const { chromium } = require('playwright'); // Or 'firefox' or 'webkit'.", + "// Start waiting for download before clicking. Note no await.", + "const downloadPromise = page.waitForEvent('download');", + "await page.getByText('Download file').click();", + "const download = await downloadPromise;", "", - "(async () => {", - " const browser = await chromium.launch();", - " const page = await browser.newPage();", - " await page.goto('https://example.com');", - " // other actions...", - " await browser.close();", - "})();" + "// Wait for the download process to complete.", + "console.log(await download.path());" ], "codeLang": "js" }, { "type": "code", "lines": [ - "import com.microsoft.playwright.*;", - "", - "public class Example {", - " public static void main(String[] args) {", - " try (Playwright playwright = Playwright.create()) {", - " BrowserType chromium = playwright.chromium();", - " Browser browser = chromium.launch();", - " Page page = browser.newPage();", - " page.navigate(\"https://example.com\");", - " // other actions...", - " browser.close();", - " }", - " }", - "}" + "// wait for download to start", + "Download download = page.waitForDownload(() -> {", + " page.getByText(\"Download file\").click();", + "});", + "// wait for download to complete", + "Path path = download.path();" ], "codeLang": "java" }, { "type": "code", "lines": [ - "import asyncio", - "from playwright.async_api import async_playwright", - "", - "async def run(playwright):", - " chromium = playwright.chromium", - " browser = await chromium.launch()", - " page = await browser.new_page()", - " await page.goto(\"https://example.com\")", - " # other actions...", - " await browser.close()", - "", - "async def main():", - " async with async_playwright() as playwright:", - " await run(playwright)", - "asyncio.run(main())" + "async with page.expect_download() as download_info:", + " await page.get_by_text(\"Download file\").click()", + "download = await download_info.value", + "# waits for download to complete", + "path = await download.path()" ], "codeLang": "python async" }, { "type": "code", "lines": [ - "from playwright.sync_api import sync_playwright", - "", - "def run(playwright):", - " chromium = playwright.chromium", - " browser = chromium.launch()", - " page = browser.new_page()", - " page.goto(\"https://example.com\")", - " # other actions...", - " browser.close()", - "", - "with sync_playwright() as playwright:", - " run(playwright)" + "with page.expect_download() as download_info:", + " page.get_by_text(\"Download file\").click()", + "download = download_info.value", + "# wait for download to complete", + "path = download.path()" ], "codeLang": "python sync" }, { "type": "code", "lines": [ - "using Microsoft.Playwright;", - "using System.Threading.Tasks;", - "", - "class BrowserTypeExamples", + "var download = await page.RunAndWaitForDownloadAsync(async () =>", "{", - " public static async Task Run()", - " {", - " using var playwright = await Playwright.CreateAsync();", - " var chromium = playwright.Chromium;", - " var browser = await chromium.LaunchAsync();", - " var page = await browser.NewPageAsync();", - " await page.GotoAsync(\"https://www.bing.com\");", - " // other actions", - " await browser.CloseAsync();", - " }", - "}" + " await page.GetByText(\"Download file\").ClickAsync();", + "});", + "Console.WriteLine(await download.PathAsync());" ], "codeLang": "csharp" } ], "langs": {}, - "comment": "BrowserType provides methods to launch a specific browser instance or connect to an existing one. The following is a\ntypical example of using Playwright to drive automation:\n\n```js\nconst { chromium } = require('playwright'); // Or 'firefox' or 'webkit'.\n\n(async () => {\n const browser = await chromium.launch();\n const page = await browser.newPage();\n await page.goto('https://example.com');\n // other actions...\n await browser.close();\n})();\n```\n\n```java\nimport com.microsoft.playwright.*;\n\npublic class Example {\n public static void main(String[] args) {\n try (Playwright playwright = Playwright.create()) {\n BrowserType chromium = playwright.chromium();\n Browser browser = chromium.launch();\n Page page = browser.newPage();\n page.navigate(\"https://example.com\");\n // other actions...\n browser.close();\n }\n }\n}\n```\n\n```python async\nimport asyncio\nfrom playwright.async_api import async_playwright\n\nasync def run(playwright):\n chromium = playwright.chromium\n browser = await chromium.launch()\n page = await browser.new_page()\n await page.goto(\"https://example.com\")\n # other actions...\n await browser.close()\n\nasync def main():\n async with async_playwright() as playwright:\n await run(playwright)\nasyncio.run(main())\n```\n\n```python sync\nfrom playwright.sync_api import sync_playwright\n\ndef run(playwright):\n chromium = playwright.chromium\n browser = chromium.launch()\n page = browser.new_page()\n page.goto(\"https://example.com\")\n # other actions...\n browser.close()\n\nwith sync_playwright() as playwright:\n run(playwright)\n```\n\n```csharp\nusing Microsoft.Playwright;\nusing System.Threading.Tasks;\n\nclass BrowserTypeExamples\n{\n public static async Task Run()\n {\n using var playwright = await Playwright.CreateAsync();\n var chromium = playwright.Chromium;\n var browser = await chromium.LaunchAsync();\n var page = await browser.NewPageAsync();\n await page.GotoAsync(\"https://www.bing.com\");\n // other actions\n await browser.CloseAsync();\n }\n}\n```\n", + "comment": "`Download` objects are dispatched by page via the [`event: Page.download`] event.\n\nAll the downloaded files belonging to the browser context are deleted when the browser context is closed.\n\nDownload event is emitted once the download starts. Download path becomes available once download completes:\n\n```js\n// Start waiting for download before clicking. Note no await.\nconst downloadPromise = page.waitForEvent('download');\nawait page.getByText('Download file').click();\nconst download = await downloadPromise;\n\n// Wait for the download process to complete.\nconsole.log(await download.path());\n```\n\n```java\n// wait for download to start\nDownload download = page.waitForDownload(() -> {\n page.getByText(\"Download file\").click();\n});\n// wait for download to complete\nPath path = download.path();\n```\n\n```py\nasync with page.expect_download() as download_info:\n await page.get_by_text(\"Download file\").click()\ndownload = await download_info.value\n# waits for download to complete\npath = await download.path()\n```\n\n```py\nwith page.expect_download() as download_info:\n page.get_by_text(\"Download file\").click()\ndownload = download_info.value\n# wait for download to complete\npath = download.path()\n```\n\n```csharp\nvar download = await page.RunAndWaitForDownloadAsync(async () =>\n{\n await page.GetByText(\"Download file\").ClickAsync();\n});\nConsole.WriteLine(await download.PathAsync());\n```\n", + "since": "v1.8", "members": [ { "kind": "method", "langs": {}, "experimental": false, - "since": "v1.8", - "name": "connect", + "since": "v1.13", + "name": "cancel", "type": { - "name": "Browser", - "expression": "[Browser]" + "name": "void" }, "spec": [ { "type": "text", - "text": "This method attaches Playwright to an existing browser instance." + "text": "Cancels a download. Will not fail if the download is already finished or canceled.↵Upon successful cancellations, `download.failure()` would resolve to `'canceled'`." } ], "required": true, - "comment": "This method attaches Playwright to an existing browser instance.", - "deprecated": false, + "comment": "Cancels a download. Will not fail if the download is already finished or canceled. Upon successful cancellations,\n`download.failure()` would resolve to `'canceled'`.", "async": true, - "alias": "connect", + "alias": "cancel", "overloadIndex": 0, "paramOrOption": null, - "args": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.10", - "name": "wsEndpoint", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "A browser websocket endpoint to connect to." - } - ], - "required": true, - "comment": "A browser websocket endpoint to connect to.", - "deprecated": false, - "async": false, - "alias": "wsEndpoint", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "options", - "type": { - "name": "Object", - "properties": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.11", - "name": "headers", - "type": { - "name": "Object", - "templates": [ - { - "name": "string" - }, - { - "name": "string" - } - ], - "expression": "[Object]<[string], [string]>" - }, - "spec": [ - { - "type": "text", - "text": "Additional HTTP headers to be sent with web socket connect request. Optional." - } - ], - "required": false, - "comment": "Additional HTTP headers to be sent with web socket connect request. Optional.", - "deprecated": false, - "async": false, - "alias": "headers", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": { - "only": [ - "js" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.14", - "name": "logger", - "type": { - "name": "Logger", - "expression": "[Logger]" - }, - "spec": [ - { - "type": "text", - "text": "Logger sink for Playwright logging. Optional." - } - ], - "required": false, - "comment": "Logger sink for Playwright logging. Optional.", - "deprecated": false, - "async": false, - "alias": "logger", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.10", - "name": "slowMo", - "type": { - "name": "float", - "expression": "[float]" - }, - "spec": [ - { - "type": "text", - "text": "Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to 0." - } - ], - "required": false, - "comment": "Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on.\nDefaults to 0.", - "deprecated": false, - "async": false, - "alias": "slowMo", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.10", - "name": "timeout", - "type": { - "name": "float", - "expression": "[float]" - }, - "spec": [ - { - "type": "text", - "text": "Maximum time in milliseconds to wait for the connection to be established. Defaults to `0` (no timeout)." - } - ], - "required": false, - "comment": "Maximum time in milliseconds to wait for the connection to be established. Defaults to `0` (no timeout).", - "deprecated": false, - "async": false, - "alias": "timeout", - "overloadIndex": 0, - "paramOrOption": null - } - ] - }, - "required": false, - "comment": "", - "deprecated": false, - "async": false, - "alias": "options", - "overloadIndex": 0, - "paramOrOption": null - } - ] + "args": [] }, { "kind": "method", - "langs": {}, + "langs": { + "only": [ + "java", + "js", + "csharp" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, - "since": "v1.9", - "name": "connectOverCDP", + "since": "v1.8", + "name": "createReadStream", "type": { - "name": "Browser", - "expression": "[Browser]" + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "Readable" + } + ], + "expression": "[null]|[Readable]" }, "spec": [ { "type": "text", - "text": "This method attaches Playwright to an existing browser instance using the Chrome DevTools Protocol." - }, - { - "type": "text", - "text": "The default browser context is accessible via [`method: Browser.contexts`]." - }, - { - "type": "note", - "noteType": "note", - "text": "Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers." - } - ], - "required": true, - "comment": "This method attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.\n\nThe default browser context is accessible via [`method: Browser.contexts`].\n\n> NOTE: Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.", - "deprecated": false, - "async": true, - "alias": "connectOverCDP", - "overloadIndex": 0, - "paramOrOption": null, - "args": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.11", - "name": "endpointURL", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "A CDP websocket endpoint or http url to connect to. For example `http://localhost:9222/` or `ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4`." - } - ], - "required": true, - "comment": "A CDP websocket endpoint or http url to connect to. For example `http://localhost:9222/` or\n`ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4`.", - "deprecated": false, - "async": false, - "alias": "endpointURL", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "options", - "type": { - "name": "Object", - "properties": [ - { - "kind": "property", - "langs": { - "only": [ - "js" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.14", - "name": "endpointURL", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "Deprecated, use the first argument instead. Optional." - } - ], - "required": false, - "comment": "Deprecated, use the first argument instead. Optional.", - "deprecated": false, - "async": false, - "alias": "endpointURL", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.11", - "name": "headers", - "type": { - "name": "Object", - "templates": [ - { - "name": "string" - }, - { - "name": "string" - } - ], - "expression": "[Object]<[string], [string]>" - }, - "spec": [ - { - "type": "text", - "text": "Additional HTTP headers to be sent with connect request. Optional." - } - ], - "required": false, - "comment": "Additional HTTP headers to be sent with connect request. Optional.", - "deprecated": false, - "async": false, - "alias": "headers", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": { - "only": [ - "js" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.14", - "name": "logger", - "type": { - "name": "Logger", - "expression": "[Logger]" - }, - "spec": [ - { - "type": "text", - "text": "Logger sink for Playwright logging. Optional." - } - ], - "required": false, - "comment": "Logger sink for Playwright logging. Optional.", - "deprecated": false, - "async": false, - "alias": "logger", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.11", - "name": "slowMo", - "type": { - "name": "float", - "expression": "[float]" - }, - "spec": [ - { - "type": "text", - "text": "Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to 0." - } - ], - "required": false, - "comment": "Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on.\nDefaults to 0.", - "deprecated": false, - "async": false, - "alias": "slowMo", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.11", - "name": "timeout", - "type": { - "name": "float", - "expression": "[float]" - }, - "spec": [ - { - "type": "text", - "text": "Maximum time in milliseconds to wait for the connection to be established. Defaults to `30000` (30 seconds). Pass `0` to disable timeout." - } - ], - "required": false, - "comment": "Maximum time in milliseconds to wait for the connection to be established. Defaults to `30000` (30 seconds). Pass `0` to\ndisable timeout.", - "deprecated": false, - "async": false, - "alias": "timeout", - "overloadIndex": 0, - "paramOrOption": null - } - ] - }, - "required": false, - "comment": "", - "deprecated": false, - "async": false, - "alias": "options", - "overloadIndex": 0, - "paramOrOption": null + "text": "Returns readable stream for current download or `null` if download failed." } - ] + ], + "required": true, + "comment": "Returns readable stream for current download or `null` if download failed.", + "async": true, + "alias": "createReadStream", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] }, { "kind": "method", "langs": {}, "experimental": false, "since": "v1.8", - "name": "executablePath", + "name": "delete", "type": { - "name": "string", - "expression": "[string]" + "name": "void" }, "spec": [ { "type": "text", - "text": "A path where Playwright expects to find a bundled browser executable." + "text": "Deletes the downloaded file. Will wait for the download to finish if necessary." } ], "required": true, - "comment": "A path where Playwright expects to find a bundled browser executable.", - "deprecated": false, - "async": false, - "alias": "executablePath", + "comment": "Deletes the downloaded file. Will wait for the download to finish if necessary.", + "async": true, + "alias": "delete", "overloadIndex": 0, "paramOrOption": null, "args": [] @@ -24212,89 +32284,314 @@ "langs": {}, "experimental": false, "since": "v1.8", - "name": "launch", + "name": "failure", "type": { - "name": "Browser", - "expression": "[Browser]" + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "string" + } + ], + "expression": "[null]|[string]" }, "spec": [ { "type": "text", - "text": "Returns the browser instance." - }, + "text": "Returns download error if any. Will wait for the download to finish if necessary." + } + ], + "required": true, + "comment": "Returns download error if any. Will wait for the download to finish if necessary.", + "async": true, + "alias": "failure", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.12", + "name": "page", + "type": { + "name": "Page", + "expression": "[Page]" + }, + "spec": [ { "type": "text", - "text": "You can use `ignoreDefaultArgs` to filter out `--mute-audio` from default arguments:" - }, - { - "type": "code", - "lines": [ - "const browser = await chromium.launch({ // Or 'firefox' or 'webkit'.", - " ignoreDefaultArgs: ['--mute-audio']", - "});" - ], - "codeLang": "js" - }, - { - "type": "code", - "lines": [ - "// Or \"firefox\" or \"webkit\".", - "Browser browser = chromium.launch(new BrowserType.LaunchOptions()", - " .setIgnoreDefaultArgs(Arrays.asList(\"--mute-audio\")));" - ], - "codeLang": "java" - }, - { - "type": "code", - "lines": [ - "browser = await playwright.chromium.launch( # or \"firefox\" or \"webkit\".", - " ignore_default_args=[\"--mute-audio\"]", - ")" - ], - "codeLang": "python async" - }, - { - "type": "code", - "lines": [ - "browser = playwright.chromium.launch( # or \"firefox\" or \"webkit\".", - " ignore_default_args=[\"--mute-audio\"]", - ")" - ], - "codeLang": "python sync" - }, + "text": "Get the page that the download belongs to." + } + ], + "required": true, + "comment": "Get the page that the download belongs to.", + "async": false, + "alias": "page", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "path", + "type": { + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "path" + } + ], + "expression": "[null]|[path]" + }, + "spec": [ { - "type": "code", - "lines": [ - "var browser = await playwright.Chromium.LaunchAsync(new BrowserTypeLaunchOptions {", - " IgnoreDefaultArgs = new[] { \"--mute-audio\" }", - "})" - ], - "codeLang": "csharp" + "type": "text", + "text": "Returns path to the downloaded file in case of successful download. The method will↵wait for the download to finish if necessary. The method throws when connected remotely." }, { "type": "text", - "text": "> **Chromium-only** Playwright can also be used to control the Google Chrome or Microsoft Edge browsers, but it works best with the version of Chromium it is bundled with. There is no guarantee it will work with any other version. Use `executablePath` option with extreme caution." - }, + "text": "Note that the download's file name is a random GUID, use [`method: Download.suggestedFilename`]↵to get suggested file name." + } + ], + "required": true, + "comment": "Returns path to the downloaded file in case of successful download. The method will wait for the download to finish\nif necessary. The method throws when connected remotely.\n\nNote that the download's file name is a random GUID, use [`method: Download.suggestedFilename`] to get suggested\nfile name.", + "async": true, + "alias": "path", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "saveAs", + "type": { + "name": "void" + }, + "spec": [ { "type": "text", - "text": ">" - }, + "text": "Copy the download to a user-specified path. It is safe to call this method while the download↵is still in progress. Will wait for the download to finish if necessary." + } + ], + "required": true, + "comment": "Copy the download to a user-specified path. It is safe to call this method while the download is still in progress.\nWill wait for the download to finish if necessary.", + "async": true, + "alias": "saveAs", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "path", + "type": { + "name": "path", + "expression": "[path]" + }, + "spec": [ + { + "type": "text", + "text": "Path where the download should be copied." + } + ], + "required": true, + "comment": "Path where the download should be copied.", + "async": false, + "alias": "path", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "suggestedFilename", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ { "type": "text", - "text": "> If Google Chrome (rather than Chromium) is preferred, a [Chrome Canary](https://www.google.com/chrome/browser/canary.html) or [Dev Channel](https://www.chromium.org/getting-involved/dev-channel) build is suggested." - }, + "text": "Returns suggested filename for this download. It is typically computed by the browser from the↵[`Content-Disposition`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition) response header↵or the `download` attribute. See the spec on [whatwg](https://html.spec.whatwg.org/#downloading-resources). Different↵browsers can use different logic for computing it." + } + ], + "required": true, + "comment": "Returns suggested filename for this download. It is typically computed by the browser from the\n[`Content-Disposition`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition) response\nheader or the `download` attribute. See the spec on [whatwg](https://html.spec.whatwg.org/#downloading-resources).\nDifferent browsers can use different logic for computing it.", + "async": false, + "alias": "suggestedFilename", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "url", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ { "type": "text", - "text": ">" - }, + "text": "Returns downloaded url." + } + ], + "required": true, + "comment": "Returns downloaded url.", + "async": false, + "alias": "url", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + } + ] + }, + { + "name": "Electron", + "spec": [ + { + "type": "text", + "text": "Playwright has **experimental** support for Electron automation. You can access electron namespace via:" + }, + { + "type": "code", + "lines": [ + "const { _electron } = require('playwright');" + ], + "codeLang": "js" + }, + { + "type": "text", + "text": "An example of the Electron automation script would be:" + }, + { + "type": "code", + "lines": [ + "const { _electron: electron } = require('playwright');", + "", + "(async () => {", + " // Launch Electron app.", + " const electronApp = await electron.launch({ args: ['main.js'] });", + "", + " // Evaluation expression in the Electron context.", + " const appPath = await electronApp.evaluate(async ({ app }) => {", + " // This runs in the main Electron process, parameter here is always", + " // the result of the require('electron') in the main app script.", + " return app.getAppPath();", + " });", + " console.log(appPath);", + "", + " // Get the first window that the app opens, wait if necessary.", + " const window = await electronApp.firstWindow();", + " // Print the title.", + " console.log(await window.title());", + " // Capture a screenshot.", + " await window.screenshot({ path: 'intro.png' });", + " // Direct Electron console to Node terminal.", + " window.on('console', console.log);", + " // Click button.", + " await window.click('text=Click me');", + " // Exit app.", + " await electronApp.close();", + "})();" + ], + "codeLang": "js" + }, + { + "type": "text", + "text": "Note that since you don't need Playwright to install web browsers when testing Electron, you can omit browser download via setting the following environment variable when installing Playwright:" + }, + { + "type": "code", + "lines": [ + "PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm i -D playwright" + ], + "codeLang": "bash js" + }, + { + "type": "text", + "text": "**Supported Electron versions are:**" + }, + { + "type": "li", + "text": "v12.2.0+", + "liType": "bullet" + }, + { + "type": "li", + "text": "v13.4.0+", + "liType": "bullet" + }, + { + "type": "li", + "text": "v14+", + "liType": "bullet" + }, + { + "type": "text", + "text": "**Known issues:**" + }, + { + "type": "text", + "text": "If you are not able to launch Electron and it will end up in timeouts during launch, try the following:" + }, + { + "type": "li", + "text": "Ensure that `nodeCliInspect` ([FuseV1Options.EnableNodeCliInspectArguments](https://www.electronjs.org/docs/latest/tutorial/fuses#nodecliinspect)) fuse is **not** set to `false`.", + "liType": "bullet" + } + ], + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "comment": "Playwright has **experimental** support for Electron automation. You can access electron namespace via:\n\n```js\nconst { _electron } = require('playwright');\n```\n\nAn example of the Electron automation script would be:\n\n```js\nconst { _electron: electron } = require('playwright');\n\n(async () => {\n // Launch Electron app.\n const electronApp = await electron.launch({ args: ['main.js'] });\n\n // Evaluation expression in the Electron context.\n const appPath = await electronApp.evaluate(async ({ app }) => {\n // This runs in the main Electron process, parameter here is always\n // the result of the require('electron') in the main app script.\n return app.getAppPath();\n });\n console.log(appPath);\n\n // Get the first window that the app opens, wait if necessary.\n const window = await electronApp.firstWindow();\n // Print the title.\n console.log(await window.title());\n // Capture a screenshot.\n await window.screenshot({ path: 'intro.png' });\n // Direct Electron console to Node terminal.\n window.on('console', console.log);\n // Click button.\n await window.click('text=Click me');\n // Exit app.\n await electronApp.close();\n})();\n```\n\nNote that since you don't need Playwright to install web browsers when testing Electron, you can omit browser\ndownload via setting the following environment variable when installing Playwright:\n\n```bash\nPLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm i -D playwright\n```\n\n**Supported Electron versions are:**\n- v12.2.0+\n- v13.4.0+\n- v14+\n\n**Known issues:**\n\nIf you are not able to launch Electron and it will end up in timeouts during launch, try the following:\n- Ensure that `nodeCliInspect`\n ([FuseV1Options.EnableNodeCliInspectArguments](https://www.electronjs.org/docs/latest/tutorial/fuses#nodecliinspect))\n fuse is **not** set to `false`.", + "since": "v1.9", + "members": [ + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.9", + "name": "launch", + "type": { + "name": "ElectronApplication", + "expression": "[ElectronApplication]" + }, + "spec": [ { "type": "text", - "text": "> Stock browsers like Google Chrome and Microsoft Edge are suitable for tests that require proprietary media codecs for video playback. See [this article](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for other differences between Chromium and Chrome. [This article](https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md) describes some differences for Linux users." + "text": "Launches electron application specified with the `executablePath`." } ], "required": true, - "comment": "Returns the browser instance.\n\nYou can use `ignoreDefaultArgs` to filter out `--mute-audio` from default arguments:\n\n```js\nconst browser = await chromium.launch({ // Or 'firefox' or 'webkit'.\n ignoreDefaultArgs: ['--mute-audio']\n});\n```\n\n```java\n// Or \"firefox\" or \"webkit\".\nBrowser browser = chromium.launch(new BrowserType.LaunchOptions()\n .setIgnoreDefaultArgs(Arrays.asList(\"--mute-audio\")));\n```\n\n```python async\nbrowser = await playwright.chromium.launch( # or \"firefox\" or \"webkit\".\n ignore_default_args=[\"--mute-audio\"]\n)\n```\n\n```python sync\nbrowser = playwright.chromium.launch( # or \"firefox\" or \"webkit\".\n ignore_default_args=[\"--mute-audio\"]\n)\n```\n\n```csharp\nvar browser = await playwright.Chromium.LaunchAsync(new BrowserTypeLaunchOptions {\n IgnoreDefaultArgs = new[] { \"--mute-audio\" }\n})\n```\n\n> **Chromium-only** Playwright can also be used to control the Google Chrome or Microsoft Edge browsers, but it works\nbest with the version of Chromium it is bundled with. There is no guarantee it will work with any other version. Use\n`executablePath` option with extreme caution.\n>\n> If Google Chrome (rather than Chromium) is preferred, a\n[Chrome Canary](https://www.google.com/chrome/browser/canary.html) or\n[Dev Channel](https://www.chromium.org/getting-involved/dev-channel) build is suggested.\n>\n> Stock browsers like Google Chrome and Microsoft Edge are suitable for tests that require proprietary media codecs for\nvideo playback. See\n[this article](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for other\ndifferences between Chromium and Chrome.\n[This article](https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md)\ndescribes some differences for Linux users.", - "deprecated": false, + "comment": "Launches electron application specified with the `executablePath`.", "async": true, "alias": "launch", "overloadIndex": 0, @@ -24313,28 +32610,22 @@ "kind": "property", "langs": {}, "experimental": false, - "since": "v1.8", - "name": "args", + "since": "v1.12", + "name": "acceptDownloads", "type": { - "name": "Array", - "templates": [ - { - "name": "string" - } - ], - "expression": "[Array]<[string]>" + "name": "boolean", + "expression": "[boolean]" }, "spec": [ { "type": "text", - "text": "Additional arguments to pass to the browser instance. The list of Chromium flags can be found [here](http://peter.sh/experiments/chromium-command-line-switches/)." + "text": "Whether to automatically download all the attachments. Defaults to `true` where all the downloads are accepted." } ], "required": false, - "comment": "Additional arguments to pass to the browser instance. The list of Chromium flags can be found\n[here](http://peter.sh/experiments/chromium-command-line-switches/).", - "deprecated": false, + "comment": "Whether to automatically download all the attachments. Defaults to `true` where all the downloads are accepted.", "async": false, - "alias": "args", + "alias": "acceptDownloads", "overloadIndex": 0, "paramOrOption": null }, @@ -24342,23 +32633,27 @@ "kind": "property", "langs": {}, "experimental": false, - "since": "v1.8", - "name": "channel", + "since": "v1.9", + "name": "args", "type": { - "name": "string", - "expression": "[string]" + "name": "Array", + "templates": [ + { + "name": "string" + } + ], + "expression": "[Array]<[string]>" }, "spec": [ { "type": "text", - "text": "Browser distribution channel. Supported values are \"chrome\", \"chrome-beta\", \"chrome-dev\", \"chrome-canary\", \"msedge\", \"msedge-beta\", \"msedge-dev\", \"msedge-canary\". Read more about using [Google Chrome and Microsoft Edge](../browsers.md#google-chrome--microsoft-edge)." + "text": "Additional arguments to pass to the application when launching. You typically pass the main↵script name here." } ], "required": false, - "comment": "Browser distribution channel. Supported values are \"chrome\", \"chrome-beta\", \"chrome-dev\", \"chrome-canary\", \"msedge\",\n\"msedge-beta\", \"msedge-dev\", \"msedge-canary\". Read more about using\n[Google Chrome and Microsoft Edge](../browsers.md#google-chrome--microsoft-edge).", - "deprecated": false, + "comment": "Additional arguments to pass to the application when launching. You typically pass the main script name here.", "async": false, - "alias": "channel", + "alias": "args", "overloadIndex": 0, "paramOrOption": null }, @@ -24366,8 +32661,8 @@ "kind": "property", "langs": {}, "experimental": false, - "since": "v1.8", - "name": "chromiumSandbox", + "since": "v1.12", + "name": "bypassCSP", "type": { "name": "boolean", "expression": "[boolean]" @@ -24375,38 +32670,63 @@ "spec": [ { "type": "text", - "text": "Enable Chromium sandboxing. Defaults to `false`." + "text": "Toggles bypassing page's Content-Security-Policy." } ], "required": false, - "comment": "Enable Chromium sandboxing. Defaults to `false`.", - "deprecated": false, + "comment": "Toggles bypassing page's Content-Security-Policy.", "async": false, - "alias": "chromiumSandbox", + "alias": "bypassCSP", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "js", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, - "since": "v1.8", - "name": "devtools", + "since": "v1.12", + "name": "colorScheme", "type": { - "name": "boolean", - "expression": "[boolean]" + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "ColorScheme", + "union": [ + { + "name": "\"light\"" + }, + { + "name": "\"dark\"" + }, + { + "name": "\"no-preference\"" + } + ] + } + ], + "expression": "null|[ColorScheme]<\"light\"|\"dark\"|\"no-preference\">" }, "spec": [ { "type": "text", - "text": "**Chromium-only** Whether to auto-open a Developer Tools panel for each tab. If this option is `true`, the `headless` option will be set `false`." + "text": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See↵[`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to `'light'`." } ], "required": false, - "comment": "**Chromium-only** Whether to auto-open a Developer Tools panel for each tab. If this option is `true`, the `headless`\noption will be set `false`.", - "deprecated": false, + "comment": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to\n`'light'`.", "async": false, - "alias": "devtools", + "alias": "colorScheme", "overloadIndex": 0, "paramOrOption": null }, @@ -24414,39 +32734,30 @@ "kind": "property", "langs": {}, "experimental": false, - "since": "v1.8", - "name": "downloadsPath", + "since": "v1.9", + "name": "cwd", "type": { - "name": "path", - "expression": "[path]" + "name": "string", + "expression": "[string]" }, "spec": [ { "type": "text", - "text": "If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed. In either case, the downloads are deleted when the browser context they were created in is closed." + "text": "Current working directory to launch application from." } ], "required": false, - "comment": "If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is\ndeleted when browser is closed. In either case, the downloads are deleted when the browser context they were created in\nis closed.", - "deprecated": false, + "comment": "Current working directory to launch application from.", "async": false, - "alias": "downloadsPath", + "alias": "cwd", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": { - "only": [ - "csharp", - "java" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, + "langs": {}, "experimental": false, - "since": "v1.8", + "since": "v1.9", "name": "env", "type": { "name": "Object", @@ -24463,12 +32774,11 @@ "spec": [ { "type": "text", - "text": "Specify environment variables that will be visible to the browser. Defaults to `process.env`." + "text": "Specifies environment variables that will be visible to Electron. Defaults to `process.env`." } ], "required": false, - "comment": "Specify environment variables that will be visible to the browser. Defaults to `process.env`.", - "deprecated": false, + "comment": "Specifies environment variables that will be visible to Electron. Defaults to `process.env`.", "async": false, "alias": "env", "overloadIndex": 0, @@ -24476,18 +32786,33 @@ }, { "kind": "property", - "langs": { - "only": [ - "js", - "python" - ], - "aliases": {}, - "types": {}, - "overrides": {} + "langs": {}, + "experimental": false, + "since": "v1.9", + "name": "executablePath", + "type": { + "name": "string", + "expression": "[string]" }, + "spec": [ + { + "type": "text", + "text": "Launches given Electron application. If not specified, launches the default Electron↵executable installed in this package, located at `node_modules/.bin/electron`." + } + ], + "required": false, + "comment": "Launches given Electron application. If not specified, launches the default Electron executable installed in this\npackage, located at `node_modules/.bin/electron`.", + "async": false, + "alias": "executablePath", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, "experimental": false, - "since": "v1.8", - "name": "env", + "since": "v1.12", + "name": "extraHTTPHeaders", "type": { "name": "Object", "templates": [ @@ -24495,33 +32820,21 @@ "name": "string" }, { - "name": "", - "union": [ - { - "name": "string" - }, - { - "name": "float" - }, - { - "name": "boolean" - } - ] + "name": "string" } ], - "expression": "[Object]<[string], [string]|[float]|[boolean]>" + "expression": "[Object]<[string], [string]>" }, "spec": [ { "type": "text", - "text": "Specify environment variables that will be visible to the browser. Defaults to `process.env`." + "text": "An object containing additional HTTP headers to be sent with every request." } ], "required": false, - "comment": "Specify environment variables that will be visible to the browser. Defaults to `process.env`.", - "deprecated": false, + "comment": "An object containing additional HTTP headers to be sent with every request.", "async": false, - "alias": "env", + "alias": "extraHTTPHeaders", "overloadIndex": 0, "paramOrOption": null }, @@ -24529,114 +32842,182 @@ "kind": "property", "langs": {}, "experimental": false, - "since": "v1.8", - "name": "executablePath", + "since": "v1.12", + "name": "geolocation", "type": { - "name": "path", - "expression": "[path]" + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "latitude", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Latitude between -90 and 90." + } + ], + "required": true, + "comment": "Latitude between -90 and 90.", + "async": false, + "alias": "latitude", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "longitude", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Longitude between -180 and 180." + } + ], + "required": true, + "comment": "Longitude between -180 and 180.", + "async": false, + "alias": "longitude", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "accuracy", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "Non-negative accuracy value. Defaults to `0`." + } + ], + "required": false, + "comment": "Non-negative accuracy value. Defaults to `0`.", + "async": false, + "alias": "accuracy", + "overloadIndex": 0, + "paramOrOption": null + } + ], + "expression": "[Object]" }, - "spec": [ - { - "type": "text", - "text": "Path to a browser executable to run instead of the bundled one. If `executablePath` is a relative path, then it is resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk." - } - ], + "spec": [], "required": false, - "comment": "Path to a browser executable to run instead of the bundled one. If `executablePath` is a relative path, then it is\nresolved relative to the current working directory. Note that Playwright only works with the bundled Chromium, Firefox\nor WebKit, use at your own risk.", - "deprecated": false, + "comment": "", "async": false, - "alias": "executablePath", + "alias": "geolocation", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": { - "only": [ - "js", - "python" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, + "langs": {}, "experimental": false, - "since": "v1.8", - "name": "firefoxUserPrefs", + "since": "v1.12", + "name": "httpCredentials", "type": { "name": "Object", - "templates": [ + "properties": [ { - "name": "string" + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "username", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "username", + "overloadIndex": 0, + "paramOrOption": null }, { - "name": "", - "union": [ - { - "name": "string" - }, - { - "name": "float" - }, + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "password", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ { - "name": "boolean" + "type": "text", + "text": "" } - ] + ], + "required": true, + "comment": "", + "async": false, + "alias": "password", + "overloadIndex": 0, + "paramOrOption": null } ], - "expression": "[Object]<[string], [string]|[float]|[boolean]>" + "expression": "[Object]" }, "spec": [ { "type": "text", - "text": "Firefox user preferences. Learn more about the Firefox user preferences at [`about:config`](https://support.mozilla.org/en-US/kb/about-config-editor-firefox)." + "text": "Credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)." } ], "required": false, - "comment": "Firefox user preferences. Learn more about the Firefox user preferences at\n[`about:config`](https://support.mozilla.org/en-US/kb/about-config-editor-firefox).", - "deprecated": false, + "comment": "Credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication).", "async": false, - "alias": "firefoxUserPrefs", + "alias": "httpCredentials", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": { - "only": [ - "csharp", - "java" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, + "langs": {}, "experimental": false, - "since": "v1.8", - "name": "firefoxUserPrefs", + "since": "v1.12", + "name": "ignoreHTTPSErrors", "type": { - "name": "Object", - "templates": [ - { - "name": "string" - }, - { - "name": "any" - } - ], - "expression": "[Object]<[string], [any]>" + "name": "boolean", + "expression": "[boolean]" }, "spec": [ { "type": "text", - "text": "Firefox user preferences. Learn more about the Firefox user preferences at [`about:config`](https://support.mozilla.org/en-US/kb/about-config-editor-firefox)." + "text": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`." } ], "required": false, - "comment": "Firefox user preferences. Learn more about the Firefox user preferences at\n[`about:config`](https://support.mozilla.org/en-US/kb/about-config-editor-firefox).", - "deprecated": false, + "comment": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.", "async": false, - "alias": "firefoxUserPrefs", + "alias": "ignoreHTTPSErrors", "overloadIndex": 0, "paramOrOption": null }, @@ -24644,23 +33025,22 @@ "kind": "property", "langs": {}, "experimental": false, - "since": "v1.8", - "name": "handleSIGHUP", + "since": "v1.12", + "name": "locale", "type": { - "name": "boolean", - "expression": "[boolean]" + "name": "string", + "expression": "[string]" }, "spec": [ { "type": "text", - "text": "Close the browser process on SIGHUP. Defaults to `true`." + "text": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value, `Accept-Language`↵request header value as well as number and date formatting rules." } ], "required": false, - "comment": "Close the browser process on SIGHUP. Defaults to `true`.", - "deprecated": false, + "comment": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value,\n`Accept-Language` request header value as well as number and date formatting rules.", "async": false, - "alias": "handleSIGHUP", + "alias": "locale", "overloadIndex": 0, "paramOrOption": null }, @@ -24668,8 +33048,8 @@ "kind": "property", "langs": {}, "experimental": false, - "since": "v1.8", - "name": "handleSIGINT", + "since": "v1.12", + "name": "offline", "type": { "name": "boolean", "expression": "[boolean]" @@ -24677,47 +33057,207 @@ "spec": [ { "type": "text", - "text": "Close the browser process on Ctrl-C. Defaults to `true`." + "text": "Whether to emulate network being offline. Defaults to `false`." } ], "required": false, - "comment": "Close the browser process on Ctrl-C. Defaults to `true`.", - "deprecated": false, + "comment": "Whether to emulate network being offline. Defaults to `false`.", "async": false, - "alias": "handleSIGINT", + "alias": "offline", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, - "since": "v1.8", - "name": "handleSIGTERM", + "since": "v1.12", + "name": "recordHar", "type": { - "name": "boolean", - "expression": "[boolean]" + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "omitContent", + "type": { + "name": "boolean", + "expression": "[boolean]" + }, + "spec": [ + { + "type": "text", + "text": "Optional setting to control whether to omit request content from the HAR. Defaults to↵`false`. Deprecated, use `content` policy instead." + } + ], + "required": false, + "comment": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`. Deprecated, use\n`content` policy instead.", + "async": false, + "alias": "omitContent", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "content", + "type": { + "name": "HarContentPolicy", + "union": [ + { + "name": "\"omit\"" + }, + { + "name": "\"embed\"" + }, + { + "name": "\"attach\"" + } + ], + "expression": "[HarContentPolicy]<\"omit\"|\"embed\"|\"attach\">" + }, + "spec": [ + { + "type": "text", + "text": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach` is specified, resources are persisted as separate files or entries in the ZIP archive. If `embed` is specified, content is stored inline the HAR file as per HAR specification. Defaults to `attach` for `.zip` output files and to `embed` for all other file extensions." + } + ], + "required": false, + "comment": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If\n`attach` is specified, resources are persisted as separate files or entries in the ZIP archive. If `embed` is\nspecified, content is stored inline the HAR file as per HAR specification. Defaults to `attach` for `.zip` output\nfiles and to `embed` for all other file extensions.", + "async": false, + "alias": "content", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "path", + "type": { + "name": "path", + "expression": "[path]" + }, + "spec": [ + { + "type": "text", + "text": "Path on the filesystem to write the HAR file to. If the file name ends with `.zip`, `content: 'attach'` is used by default." + } + ], + "required": true, + "comment": "Path on the filesystem to write the HAR file to. If the file name ends with `.zip`, `content: 'attach'` is used by\ndefault.", + "async": false, + "alias": "path", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "mode", + "type": { + "name": "HarMode", + "union": [ + { + "name": "\"full\"" + }, + { + "name": "\"minimal\"" + } + ], + "expression": "[HarMode]<\"full\"|\"minimal\">" + }, + "spec": [ + { + "type": "text", + "text": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to `full`." + } + ], + "required": false, + "comment": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page,\ncookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.", + "async": false, + "alias": "mode", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "urlFilter", + "type": { + "name": "", + "union": [ + { + "name": "string" + }, + { + "name": "RegExp" + } + ], + "expression": "[string]|[RegExp]" + }, + "spec": [ + { + "type": "text", + "text": "A glob or regex pattern to filter requests that are stored in the HAR. When a `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." + } + ], + "required": false, + "comment": "A glob or regex pattern to filter requests that are stored in the HAR. When a `baseURL` via the context options was\nprovided and the passed URL is a path, it gets merged via the\n[`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor.", + "async": false, + "alias": "urlFilter", + "overloadIndex": 0, + "paramOrOption": null + } + ], + "expression": "[Object]" }, "spec": [ { "type": "text", - "text": "Close the browser process on SIGTERM. Defaults to `true`." + "text": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into `recordHar.path` file. If not↵specified, the HAR is not recorded. Make sure to await [`method: BrowserContext.close`] for the HAR to be↵saved." } ], "required": false, - "comment": "Close the browser process on SIGTERM. Defaults to `true`.", - "deprecated": false, + "comment": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into `recordHar.path` file.\nIf not specified, the HAR is not recorded. Make sure to await [`method: BrowserContext.close`] for the HAR to be\nsaved.", "async": false, - "alias": "handleSIGTERM", + "alias": "recordHar", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "csharp", + "java", + "python" + ], + "aliases": { + "python": "record_har_omit_content" + }, + "types": {}, + "overrides": {} + }, "experimental": false, - "since": "v1.8", - "name": "headless", + "since": "v1.12", + "name": "recordHarOmitContent", "type": { "name": "boolean", "expression": "[boolean]" @@ -24725,14 +33265,13 @@ "spec": [ { "type": "text", - "text": "Whether to run browser in headless mode. More details for [Chromium](https://developers.google.com/web/updates/2017/04/headless-chrome) and [Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Firefox/Headless_mode). Defaults to `true` unless the `devtools` option is `true`." + "text": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`." } ], "required": false, - "comment": "Whether to run browser in headless mode. More details for\n[Chromium](https://developers.google.com/web/updates/2017/04/headless-chrome) and\n[Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Firefox/Headless_mode). Defaults to `true` unless the\n`devtools` option is `true`.", - "deprecated": false, + "comment": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`.", "async": false, - "alias": "headless", + "alias": "recordHarOmitContent", "overloadIndex": 0, "paramOrOption": null }, @@ -24741,30 +33280,32 @@ "langs": { "only": [ "csharp", - "java" + "java", + "python" ], - "aliases": {}, + "aliases": { + "python": "record_har_path" + }, "types": {}, "overrides": {} }, "experimental": false, - "since": "v1.9", - "name": "ignoreAllDefaultArgs", + "since": "v1.12", + "name": "recordHarPath", "type": { - "name": "boolean", - "expression": "[boolean]" + "name": "path", + "expression": "[path]" }, "spec": [ { "type": "text", - "text": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. Dangerous option; use with care. Defaults to `false`." + "text": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the↵specified HAR file on the filesystem. If not specified, the HAR is not recorded. Make sure to↵call [`method: BrowserContext.close`] for the HAR to be saved." } ], "required": false, - "comment": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. Dangerous option;\nuse with care. Defaults to `false`.", - "deprecated": false, + "comment": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the specified HAR file\non the filesystem. If not specified, the HAR is not recorded. Make sure to call [`method: BrowserContext.close`]\nfor the HAR to be saved.", "async": false, - "alias": "ignoreAllDefaultArgs", + "alias": "recordHarPath", "overloadIndex": 0, "paramOrOption": null }, @@ -24772,44 +33313,125 @@ "kind": "property", "langs": { "only": [ - "js", - "python" + "js" ], "aliases": {}, "types": {}, "overrides": {} }, "experimental": false, - "since": "v1.8", - "name": "ignoreDefaultArgs", + "since": "v1.12", + "name": "recordVideo", "type": { - "name": "", - "union": [ + "name": "Object", + "properties": [ { - "name": "boolean" + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "dir", + "type": { + "name": "path", + "expression": "[path]" + }, + "spec": [ + { + "type": "text", + "text": "Path to the directory to put videos into." + } + ], + "required": true, + "comment": "Path to the directory to put videos into.", + "async": false, + "alias": "dir", + "overloadIndex": 0, + "paramOrOption": null }, { - "name": "Array", - "templates": [ + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "size", + "type": { + "name": "Object", + "properties": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "width", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "Video frame width." + } + ], + "required": true, + "comment": "Video frame width.", + "async": false, + "alias": "width", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "height", + "type": { + "name": "int", + "expression": "[int]" + }, + "spec": [ + { + "type": "text", + "text": "Video frame height." + } + ], + "required": true, + "comment": "Video frame height.", + "async": false, + "alias": "height", + "overloadIndex": 0, + "paramOrOption": null + } + ], + "expression": "[Object]" + }, + "spec": [ { - "name": "string" + "type": "text", + "text": "Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport`↵scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450.↵Actual picture of each page will be scaled down if necessary to fit the specified size." } - ] + ], + "required": false, + "comment": "Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to\nfit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of\neach page will be scaled down if necessary to fit the specified size.", + "async": false, + "alias": "size", + "overloadIndex": 0, + "paramOrOption": null } ], - "expression": "[boolean]|[Array]<[string]>" + "expression": "[Object]" }, "spec": [ { "type": "text", - "text": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. If an array is given, then filters out the given default arguments. Dangerous option; use with care. Defaults to `false`." + "text": "Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make↵sure to await [`method: BrowserContext.close`] for videos to be saved." } ], "required": false, - "comment": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. If an array is\ngiven, then filters out the given default arguments. Dangerous option; use with care. Defaults to `false`.", - "deprecated": false, + "comment": "Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded.\nMake sure to await [`method: BrowserContext.close`] for videos to be saved.", "async": false, - "alias": "ignoreDefaultArgs", + "alias": "recordVideo", "overloadIndex": 0, "paramOrOption": null }, @@ -24818,35 +33440,32 @@ "langs": { "only": [ "csharp", - "java" + "java", + "python" ], - "aliases": {}, + "aliases": { + "python": "record_video_dir" + }, "types": {}, "overrides": {} }, "experimental": false, - "since": "v1.8", - "name": "ignoreDefaultArgs", + "since": "v1.12", + "name": "recordVideoDir", "type": { - "name": "Array", - "templates": [ - { - "name": "string" - } - ], - "expression": "[Array]<[string]>" + "name": "path", + "expression": "[path]" }, "spec": [ { "type": "text", - "text": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. Dangerous option; use with care." + "text": "Enables video recording for all pages into the specified directory. If not specified videos are↵not recorded. Make sure to call [`method: BrowserContext.close`] for videos to be saved." } ], "required": false, - "comment": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. Dangerous option;\nuse with care.", - "deprecated": false, + "comment": "Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make\nsure to call [`method: BrowserContext.close`] for videos to be saved.", "async": false, - "alias": "ignoreDefaultArgs", + "alias": "recordVideoDir", "overloadIndex": 0, "paramOrOption": null }, @@ -24854,39 +33473,19 @@ "kind": "property", "langs": { "only": [ - "js" + "csharp", + "java", + "python" ], - "aliases": {}, + "aliases": { + "python": "record_video_size" + }, "types": {}, "overrides": {} }, "experimental": false, - "since": "v1.8", - "name": "logger", - "type": { - "name": "Logger", - "expression": "[Logger]" - }, - "spec": [ - { - "type": "text", - "text": "Logger sink for Playwright logging." - } - ], - "required": false, - "comment": "Logger sink for Playwright logging.", - "deprecated": false, - "async": false, - "alias": "logger", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "proxy", + "since": "v1.12", + "name": "recordVideoSize", "type": { "name": "Object", "properties": [ @@ -24895,70 +33494,21 @@ "langs": {}, "experimental": false, "since": "v1.0", - "name": "server", + "name": "width", "type": { - "name": "string", - "expression": "[string]" + "name": "int", + "expression": "[int]" }, "spec": [ { "type": "text", - "text": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example `http://myproxy.com:3128` or `socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP proxy." + "text": "Video frame width." } ], "required": true, - "comment": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example `http://myproxy.com:3128` or\n`socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP proxy.", - "deprecated": false, - "async": false, - "alias": "server", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "bypass", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "Optional comma-separated domains to bypass proxy, for example `\".com, chromium.org, .domain.com\"`." - } - ], - "required": false, - "comment": "Optional comma-separated domains to bypass proxy, for example `\".com, chromium.org, .domain.com\"`.", - "deprecated": false, - "async": false, - "alias": "bypass", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "username", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "Optional username to use if HTTP proxy requires authentication." - } - ], - "required": false, - "comment": "Optional username to use if HTTP proxy requires authentication.", - "deprecated": false, + "comment": "Video frame width.", "async": false, - "alias": "username", + "alias": "width", "overloadIndex": 0, "paramOrOption": null }, @@ -24967,22 +33517,21 @@ "langs": {}, "experimental": false, "since": "v1.0", - "name": "password", + "name": "height", "type": { - "name": "string", - "expression": "[string]" + "name": "int", + "expression": "[int]" }, "spec": [ { "type": "text", - "text": "Optional password to use if HTTP proxy requires authentication." + "text": "Video frame height." } ], - "required": false, - "comment": "Optional password to use if HTTP proxy requires authentication.", - "deprecated": false, + "required": true, + "comment": "Video frame height.", "async": false, - "alias": "password", + "alias": "height", "overloadIndex": 0, "paramOrOption": null } @@ -24992,14 +33541,13 @@ "spec": [ { "type": "text", - "text": "Network proxy settings." + "text": "Dimensions of the recorded videos. If not specified the size will be equal to `viewport`↵scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450.↵Actual picture of each page will be scaled down if necessary to fit the specified size." } ], "required": false, - "comment": "Network proxy settings.", - "deprecated": false, + "comment": "Dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit into\n800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page\nwill be scaled down if necessary to fit the specified size.", "async": false, - "alias": "proxy", + "alias": "recordVideoSize", "overloadIndex": 0, "paramOrOption": null }, @@ -25007,8 +33555,8 @@ "kind": "property", "langs": {}, "experimental": false, - "since": "v1.8", - "name": "slowMo", + "since": "v1.15", + "name": "timeout", "type": { "name": "float", "expression": "[float]" @@ -25016,14 +33564,13 @@ "spec": [ { "type": "text", - "text": "Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on." + "text": "Maximum time in milliseconds to wait for the application to start. Defaults to `30000` (30 seconds). Pass `0` to disable timeout." } ], "required": false, - "comment": "Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on.", - "deprecated": false, + "comment": "Maximum time in milliseconds to wait for the application to start. Defaults to `30000` (30 seconds). Pass `0` to\ndisable timeout.", "async": false, - "alias": "slowMo", + "alias": "timeout", "overloadIndex": 0, "paramOrOption": null }, @@ -25031,57 +33578,473 @@ "kind": "property", "langs": {}, "experimental": false, - "since": "v1.8", - "name": "timeout", + "since": "v1.12", + "name": "timezoneId", "type": { - "name": "float", - "expression": "[float]" + "name": "string", + "expression": "[string]" }, "spec": [ { "type": "text", - "text": "Maximum time in milliseconds to wait for the browser instance to start. Defaults to `30000` (30 seconds). Pass `0` to disable timeout." + "text": "Changes the timezone of the context. See [ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1)↵for a list of supported timezone IDs." } ], "required": false, - "comment": "Maximum time in milliseconds to wait for the browser instance to start. Defaults to `30000` (30 seconds). Pass `0` to\ndisable timeout.", - "deprecated": false, + "comment": "Changes the timezone of the context. See\n[ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1)\nfor a list of supported timezone IDs.", "async": false, - "alias": "timeout", + "alias": "timezoneId", "overloadIndex": 0, "paramOrOption": null - }, - { + } + ] + }, + "required": false, + "comment": "", + "async": false, + "alias": "options", + "overloadIndex": 0, + "paramOrOption": null + } + ] + } + ] + }, + { + "name": "ElectronApplication", + "spec": [ + { + "type": "text", + "text": "Electron application representation. You can use [`method: Electron.launch`] to↵obtain the application instance. This instance you can control main electron process↵as well as work with Electron windows:" + }, + { + "type": "code", + "lines": [ + "const { _electron: electron } = require('playwright');", + "", + "(async () => {", + " // Launch Electron app.", + " const electronApp = await electron.launch({ args: ['main.js'] });", + "", + " // Evaluation expression in the Electron context.", + " const appPath = await electronApp.evaluate(async ({ app }) => {", + " // This runs in the main Electron process, parameter here is always", + " // the result of the require('electron') in the main app script.", + " return app.getAppPath();", + " });", + " console.log(appPath);", + "", + " // Get the first window that the app opens, wait if necessary.", + " const window = await electronApp.firstWindow();", + " // Print the title.", + " console.log(await window.title());", + " // Capture a screenshot.", + " await window.screenshot({ path: 'intro.png' });", + " // Direct Electron console to Node terminal.", + " window.on('console', console.log);", + " // Click button.", + " await window.click('text=Click me');", + " // Exit app.", + " await electronApp.close();", + "})();" + ], + "codeLang": "js" + } + ], + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "comment": "Electron application representation. You can use [`method: Electron.launch`] to obtain the application instance.\nThis instance you can control main electron process as well as work with Electron windows:\n\n```js\nconst { _electron: electron } = require('playwright');\n\n(async () => {\n // Launch Electron app.\n const electronApp = await electron.launch({ args: ['main.js'] });\n\n // Evaluation expression in the Electron context.\n const appPath = await electronApp.evaluate(async ({ app }) => {\n // This runs in the main Electron process, parameter here is always\n // the result of the require('electron') in the main app script.\n return app.getAppPath();\n });\n console.log(appPath);\n\n // Get the first window that the app opens, wait if necessary.\n const window = await electronApp.firstWindow();\n // Print the title.\n console.log(await window.title());\n // Capture a screenshot.\n await window.screenshot({ path: 'intro.png' });\n // Direct Electron console to Node terminal.\n window.on('console', console.log);\n // Click button.\n await window.click('text=Click me');\n // Exit app.\n await electronApp.close();\n})();\n```\n", + "since": "v1.9", + "members": [ + { + "kind": "event", + "langs": {}, + "experimental": false, + "since": "v1.9", + "name": "close", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "This event is issued when the application closes." + } + ], + "required": true, + "comment": "This event is issued when the application closes.", + "async": false, + "alias": "close", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "event", + "langs": {}, + "experimental": false, + "since": "v1.9", + "name": "window", + "type": { + "name": "Page", + "expression": "[Page]" + }, + "spec": [ + { + "type": "text", + "text": "This event is issued for every window that is created **and loaded** in Electron. It contains a `Page` that can↵be used for Playwright automation." + } + ], + "required": true, + "comment": "This event is issued for every window that is created **and loaded** in Electron. It contains a `Page` that can be\nused for Playwright automation.", + "async": false, + "alias": "window", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.11", + "name": "browserWindow", + "type": { + "name": "JSHandle", + "expression": "[JSHandle]" + }, + "spec": [ + { + "type": "text", + "text": "Returns the BrowserWindow object that corresponds to the given Playwright page." + } + ], + "required": true, + "comment": "Returns the BrowserWindow object that corresponds to the given Playwright page.", + "async": true, + "alias": "browserWindow", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.11", + "name": "page", + "type": { + "name": "Page", + "expression": "[Page]" + }, + "spec": [ + { + "type": "text", + "text": "Page to retrieve the window for." + } + ], + "required": true, + "comment": "Page to retrieve the window for.", + "async": false, + "alias": "page", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.9", + "name": "close", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "Closes Electron application." + } + ], + "required": true, + "comment": "Closes Electron application.", + "async": true, + "alias": "close", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.9", + "name": "context", + "type": { + "name": "BrowserContext", + "expression": "[BrowserContext]" + }, + "spec": [ + { + "type": "text", + "text": "This method returns browser context that can be used for setting up context-wide routing, etc." + } + ], + "required": true, + "comment": "This method returns browser context that can be used for setting up context-wide routing, etc.", + "async": false, + "alias": "context", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.9", + "name": "evaluate", + "type": { + "name": "Serializable", + "expression": "[Serializable]" + }, + "spec": [ + { + "type": "text", + "text": "Returns the return value of `expression`." + }, + { + "type": "text", + "text": "If the function passed to the [`method: ElectronApplication.evaluate`] returns a [Promise], then↵[`method: ElectronApplication.evaluate`] would wait for the promise to resolve and return its value." + }, + { + "type": "text", + "text": "If the function passed to the [`method: ElectronApplication.evaluate`] returns a non-[Serializable] value, then↵[`method: ElectronApplication.evaluate`] returns `undefined`. Playwright also supports transferring↵some additional values that are not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`." + } + ], + "required": true, + "comment": "Returns the return value of `expression`.\n\nIf the function passed to the [`method: ElectronApplication.evaluate`] returns a [Promise], then\n[`method: ElectronApplication.evaluate`] would wait for the promise to resolve and return its value.\n\nIf the function passed to the [`method: ElectronApplication.evaluate`] returns a non-[Serializable] value, then\n[`method: ElectronApplication.evaluate`] returns `undefined`. Playwright also supports transferring some additional\nvalues that are not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`.", + "async": true, + "alias": "evaluate", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": { + "overrides": { + "js": { + "kind": "property", + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.9", + "name": "expression", + "type": { + "name": "", + "union": [ + { + "name": "function" + }, + { + "name": "Electron" + } + ], + "expression": "[function]|[Electron]" + }, + "spec": [ + { + "type": "text", + "text": "Function to be evaluated in the main Electron process." + } + ], + "argsArray": [], + "required": true, + "comment": "", + "args": {}, + "clazz": null, + "async": false, + "alias": "pageFunction", + "overloadIndex": 0, + "paramOrOption": null + } + } + }, + "experimental": false, + "since": "v1.9", + "name": "expression", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "JavaScript expression to be evaluated in the browser context. If the expression evaluates↵to a function, the function is automatically invoked." + } + ], + "required": true, + "comment": "JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the\nfunction is automatically invoked.", + "async": false, + "alias": "expression", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.9", + "name": "arg", + "type": { + "name": "EvaluationArgument", + "expression": "[EvaluationArgument]" + }, + "spec": [ + { + "type": "text", + "text": "Optional argument to pass to `expression`." + } + ], + "required": false, + "comment": "Optional argument to pass to `expression`.", + "async": false, + "alias": "arg", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.9", + "name": "evaluateHandle", + "type": { + "name": "JSHandle", + "expression": "[JSHandle]" + }, + "spec": [ + { + "type": "text", + "text": "Returns the return value of `expression` as a `JSHandle`." + }, + { + "type": "text", + "text": "The only difference between [`method: ElectronApplication.evaluate`] and [`method: ElectronApplication.evaluateHandle`] is that [`method: ElectronApplication.evaluateHandle`] returns `JSHandle`." + }, + { + "type": "text", + "text": "If the function passed to the [`method: ElectronApplication.evaluateHandle`] returns a [Promise], then↵[`method: ElectronApplication.evaluateHandle`] would wait for the promise to resolve and return its value." + } + ], + "required": true, + "comment": "Returns the return value of `expression` as a `JSHandle`.\n\nThe only difference between [`method: ElectronApplication.evaluate`] and\n[`method: ElectronApplication.evaluateHandle`] is that [`method: ElectronApplication.evaluateHandle`] returns\n`JSHandle`.\n\nIf the function passed to the [`method: ElectronApplication.evaluateHandle`] returns a [Promise], then\n[`method: ElectronApplication.evaluateHandle`] would wait for the promise to resolve and return its value.", + "async": true, + "alias": "evaluateHandle", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": { + "overrides": { + "js": { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, - "since": "v1.8", - "name": "tracesDir", + "since": "v1.9", + "name": "expression", "type": { - "name": "path", - "expression": "[path]" + "name": "", + "union": [ + { + "name": "function" + }, + { + "name": "Electron" + } + ], + "expression": "[function]|[Electron]" }, "spec": [ { "type": "text", - "text": "If specified, traces are saved into this directory." + "text": "Function to be evaluated in the main Electron process." } ], - "required": false, - "comment": "If specified, traces are saved into this directory.", - "deprecated": false, + "argsArray": [], + "required": true, + "comment": "", + "args": {}, + "clazz": null, "async": false, - "alias": "tracesDir", + "alias": "pageFunction", "overloadIndex": 0, "paramOrOption": null } - ] + } + }, + "experimental": false, + "since": "v1.9", + "name": "expression", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "JavaScript expression to be evaluated in the browser context. If the expression evaluates↵to a function, the function is automatically invoked." + } + ], + "required": true, + "comment": "JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the\nfunction is automatically invoked.", + "async": false, + "alias": "expression", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.9", + "name": "arg", + "type": { + "name": "EvaluationArgument", + "expression": "[EvaluationArgument]" }, + "spec": [ + { + "type": "text", + "text": "Optional argument to pass to `expression`." + } + ], "required": false, - "comment": "", - "deprecated": false, + "comment": "Optional argument to pass to `expression`.", "async": false, - "alias": "options", + "alias": "arg", "overloadIndex": 0, "paramOrOption": null } @@ -25091,200 +34054,462 @@ "kind": "method", "langs": {}, "experimental": false, - "since": "v1.8", - "name": "launchPersistentContext", + "since": "v1.9", + "name": "firstWindow", "type": { - "name": "BrowserContext", - "expression": "[BrowserContext]" + "name": "Page", + "expression": "[Page]" }, "spec": [ { "type": "text", - "text": "Returns the persistent browser context instance." + "text": "Convenience method that waits for the first application window to be opened." }, { "type": "text", - "text": "Launches browser that uses persistent storage located at `userDataDir` and returns the only context. Closing this context will automatically close the browser." + "text": "**Usage**" + }, + { + "type": "code", + "lines": [ + " const electronApp = await electron.launch({", + " args: ['main.js']", + " });", + " const window = await electronApp.firstWindow();", + " // ..." + ], + "codeLang": "js" } ], "required": true, - "comment": "Returns the persistent browser context instance.\n\nLaunches browser that uses persistent storage located at `userDataDir` and returns the only context. Closing this\ncontext will automatically close the browser.", - "deprecated": false, + "comment": "Convenience method that waits for the first application window to be opened.\n\n**Usage**\n\n```js\n const electronApp = await electron.launch({\n args: ['main.js']\n });\n const window = await electronApp.firstWindow();\n // ...\n```\n", "async": true, - "alias": "launchPersistentContext", + "alias": "firstWindow", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.21", + "name": "process", + "type": { + "name": "ChildProcess", + "expression": "[ChildProcess]" + }, + "spec": [ + { + "type": "text", + "text": "Returns the main process for this Electron Application." + } + ], + "required": true, + "comment": "Returns the main process for this Electron Application.", + "async": false, + "alias": "process", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.9", + "name": "waitForEvent", + "type": { + "name": "any", + "expression": "[any]" + }, + "spec": [ + { + "type": "text", + "text": "Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy value. Will throw an error if the application is closed before the event is fired. Returns the event data value." + }, + { + "type": "text", + "text": "**Usage**" + }, + { + "type": "code", + "lines": [ + "const windowPromise = electronApp.waitForEvent('window');", + "await mainWindow.click('button');", + "const window = await windowPromise;" + ], + "codeLang": "js" + } + ], + "required": true, + "comment": "Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy\nvalue. Will throw an error if the application is closed before the event is fired. Returns the event data value.\n\n**Usage**\n\n```js\nconst windowPromise = electronApp.waitForEvent('window');\nawait mainWindow.click('button');\nconst window = await windowPromise;\n```\n", + "async": true, + "alias": "waitForEvent", "overloadIndex": 0, "paramOrOption": null, "args": [ { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "js", + "python", + "java" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, - "since": "v1.8", - "name": "userDataDir", + "since": "v1.9", + "name": "event", "type": { - "name": "path", - "expression": "[path]" + "name": "string", + "expression": "[string]" }, "spec": [ { "type": "text", - "text": "Path to a User Data Directory, which stores browser session data like cookies and local storage. More details for [Chromium](https://chromium.googlesource.com/chromium/src/+/master/docs/user_data_dir.md#introduction) and [Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Command_Line_Options#User_Profile). Note that Chromium's user data directory is the **parent** directory of the \"Profile Path\" seen at `chrome://version`. Pass an empty string to use a temporary directory instead." + "text": "Event name, same one typically passed into `*.on(event)`." } ], "required": true, - "comment": "Path to a User Data Directory, which stores browser session data like cookies and local storage. More details for\n[Chromium](https://chromium.googlesource.com/chromium/src/+/master/docs/user_data_dir.md#introduction) and\n[Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Command_Line_Options#User_Profile). Note that Chromium's user\ndata directory is the **parent** directory of the \"Profile Path\" seen at `chrome://version`. Pass an empty string to use\na temporary directory instead.", - "deprecated": false, + "comment": "Event name, same one typically passed into `*.on(event)`.", "async": false, - "alias": "userDataDir", + "alias": "event", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": {}, + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} + }, "experimental": false, - "since": "v1.0", - "name": "options", + "since": "v1.9", + "name": "optionsOrPredicate", "type": { - "name": "Object", - "properties": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "acceptDownloads", - "type": { - "name": "boolean", - "expression": "[boolean]" - }, - "spec": [ - { - "type": "text", - "text": "Whether to automatically download all the attachments. Defaults to `true` where all the downloads are accepted." - } - ], - "required": false, - "comment": "Whether to automatically download all the attachments. Defaults to `true` where all the downloads are accepted.", - "deprecated": false, - "async": false, - "alias": "acceptDownloads", - "overloadIndex": 0, - "paramOrOption": null - }, + "name": "", + "union": [ { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "args", - "type": { - "name": "Array", - "templates": [ - { - "name": "string" - } - ], - "expression": "[Array]<[string]>" - }, - "spec": [ - { - "type": "text", - "text": "Additional arguments to pass to the browser instance. The list of Chromium flags can be found [here](http://peter.sh/experiments/chromium-command-line-switches/)." - } - ], - "required": false, - "comment": "Additional arguments to pass to the browser instance. The list of Chromium flags can be found\n[here](http://peter.sh/experiments/chromium-command-line-switches/).", - "deprecated": false, - "async": false, - "alias": "args", - "overloadIndex": 0, - "paramOrOption": null + "name": "function" }, { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "baseURL", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "When using [`method: Page.goto`], [`method: Page.route`], [`method: Page.waitForURL`], [`method: Page.waitForRequest`], or [`method: Page.waitForResponse`] it takes the base URL in consideration by using the [`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the corresponding URL. Examples:" - }, - { - "type": "li", - "text": "baseURL: `http://localhost:3000` and navigating to `/bar.html` results in `http://localhost:3000/bar.html`", - "liType": "bullet" - }, + "name": "Object", + "properties": [ { - "type": "li", - "text": "baseURL: `http://localhost:3000/foo/` and navigating to `./bar.html` results in `http://localhost:3000/foo/bar.html`", - "liType": "bullet" + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "predicate", + "type": { + "name": "function", + "expression": "[function]" + }, + "spec": [ + { + "type": "text", + "text": "receives the event data and resolves to truthy value when the waiting should resolve." + } + ], + "required": true, + "comment": "receives the event data and resolves to truthy value when the waiting should resolve.", + "async": false, + "alias": "predicate", + "overloadIndex": 0, + "paramOrOption": null }, { - "type": "li", - "text": "baseURL: `http://localhost:3000/foo` (without trailing slash) and navigating to `./bar.html` results in `http://localhost:3000/bar.html`", - "liType": "bullet" - } - ], - "required": false, - "comment": "When using [`method: Page.goto`], [`method: Page.route`], [`method: Page.waitForURL`], [`method: Page.waitForRequest`],\nor [`method: Page.waitForResponse`] it takes the base URL in consideration by using the\n[`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the corresponding URL.\nExamples:\n- baseURL: `http://localhost:3000` and navigating to `/bar.html` results in `http://localhost:3000/bar.html`\n- baseURL: `http://localhost:3000/foo/` and navigating to `./bar.html` results in `http://localhost:3000/foo/bar.html`\n- baseURL: `http://localhost:3000/foo` (without trailing slash) and navigating to `./bar.html` results in\n `http://localhost:3000/bar.html`", - "deprecated": false, - "async": false, - "alias": "baseURL", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "bypassCSP", - "type": { - "name": "boolean", - "expression": "[boolean]" - }, - "spec": [ - { - "type": "text", - "text": "Toggles bypassing page's Content-Security-Policy." + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "timeout", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to↵disable timeout. The default value can be changed by using the [`method: BrowserContext.setDefaultTimeout`]." + } + ], + "required": false, + "comment": "maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The\ndefault value can be changed by using the [`method: BrowserContext.setDefaultTimeout`].", + "async": false, + "alias": "timeout", + "overloadIndex": 0, + "paramOrOption": null } - ], - "required": false, - "comment": "Toggles bypassing page's Content-Security-Policy.", - "deprecated": false, - "async": false, - "alias": "bypassCSP", - "overloadIndex": 0, - "paramOrOption": null - }, + ] + } + ], + "expression": "[function]|[Object]" + }, + "spec": [ + { + "type": "text", + "text": "Either a predicate that receives an event or an options object. Optional." + } + ], + "required": false, + "comment": "Either a predicate that receives an event or an options object. Optional.", + "async": false, + "alias": "optionsOrPredicate", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.9", + "name": "windows", + "type": { + "name": "Array", + "templates": [ + { + "name": "Page" + } + ], + "expression": "[Array]<[Page]>" + }, + "spec": [ + { + "type": "text", + "text": "Convenience method that returns all the opened windows." + } + ], + "required": true, + "comment": "Convenience method that returns all the opened windows.", + "async": false, + "alias": "windows", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + } + ] + }, + { + "name": "ElementHandle", + "spec": [ + { + "type": "li", + "text": "extends: `JSHandle`", + "liType": "bullet" + }, + { + "type": "text", + "text": "ElementHandle represents an in-page DOM element. ElementHandles can be created with the [`method: Page.querySelector`] method." + }, + { + "type": "note", + "noteType": "caution Discouraged", + "text": "The use of ElementHandle is discouraged, use `Locator` objects and web-first assertions instead." + }, + { + "type": "code", + "lines": [ + "const hrefElement = await page.$('a');", + "await hrefElement.click();" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "ElementHandle hrefElement = page.querySelector(\"a\");", + "hrefElement.click();" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "href_element = await page.query_selector(\"a\")", + "await href_element.click()" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "href_element = page.query_selector(\"a\")", + "href_element.click()" + ], + "codeLang": "python sync" + }, + { + "type": "code", + "lines": [ + "var handle = await page.QuerySelectorAsync(\"a\");", + "await handle.ClickAsync();" + ], + "codeLang": "csharp" + }, + { + "type": "text", + "text": "ElementHandle prevents DOM element from garbage collection unless the handle is disposed with↵[`method: JSHandle.dispose`]. ElementHandles are auto-disposed when their origin frame gets navigated." + }, + { + "type": "text", + "text": "ElementHandle instances can be used as an argument in [`method: Page.evalOnSelector`] and [`method: Page.evaluate`] methods." + }, + { + "type": "text", + "text": "The difference between the `Locator` and ElementHandle is that the ElementHandle points to a particular element, while `Locator` captures the logic of how to retrieve an element." + }, + { + "type": "text", + "text": "In the example below, handle points to a particular DOM element on page. If that element changes text or is used by React to render an entirely different component, handle is still pointing to that very DOM element. This can lead to unexpected behaviors." + }, + { + "type": "code", + "lines": [ + "const handle = await page.$('text=Submit');", + "// ...", + "await handle.hover();", + "await handle.click();" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "ElementHandle handle = page.querySelector(\"text=Submit\");", + "handle.hover();", + "handle.click();" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "handle = await page.query_selector(\"text=Submit\")", + "await handle.hover()", + "await handle.click()" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "handle = page.query_selector(\"text=Submit\")", + "handle.hover()", + "handle.click()" + ], + "codeLang": "python sync" + }, + { + "type": "code", + "lines": [ + "var handle = await page.QuerySelectorAsync(\"text=Submit\");", + "await handle.HoverAsync();", + "await handle.ClickAsync();" + ], + "codeLang": "csharp" + }, + { + "type": "text", + "text": "With the locator, every time the `element` is used, up-to-date DOM element is located in the page using the selector. So in the snippet below, underlying DOM element is going to be located twice." + }, + { + "type": "code", + "lines": [ + "const locator = page.getByText('Submit');", + "// ...", + "await locator.hover();", + "await locator.click();" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "Locator locator = page.getByText(\"Submit\");", + "locator.hover();", + "locator.click();" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "locator = page.get_by_text(\"Submit\")", + "await locator.hover()", + "await locator.click()" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "locator = page.get_by_text(\"Submit\")", + "locator.hover()", + "locator.click()" + ], + "codeLang": "python sync" + }, + { + "type": "code", + "lines": [ + "var locator = page.GetByText(\"Submit\");", + "await locator.HoverAsync();", + "await locator.ClickAsync();" + ], + "codeLang": "csharp" + } + ], + "extends": "JSHandle", + "langs": {}, + "comment": "- extends: `JSHandle`\n\nElementHandle represents an in-page DOM element. ElementHandles can be created with the\n[`method: Page.querySelector`] method.\n\n**NOTE** The use of ElementHandle is discouraged, use `Locator` objects and web-first assertions instead.\n\n```js\nconst hrefElement = await page.$('a');\nawait hrefElement.click();\n```\n\n```java\nElementHandle hrefElement = page.querySelector(\"a\");\nhrefElement.click();\n```\n\n```py\nhref_element = await page.query_selector(\"a\")\nawait href_element.click()\n```\n\n```py\nhref_element = page.query_selector(\"a\")\nhref_element.click()\n```\n\n```csharp\nvar handle = await page.QuerySelectorAsync(\"a\");\nawait handle.ClickAsync();\n```\n\nElementHandle prevents DOM element from garbage collection unless the handle is disposed with\n[`method: JSHandle.dispose`]. ElementHandles are auto-disposed when their origin frame gets navigated.\n\nElementHandle instances can be used as an argument in [`method: Page.evalOnSelector`] and [`method: Page.evaluate`]\nmethods.\n\nThe difference between the `Locator` and ElementHandle is that the ElementHandle points to a particular element,\nwhile `Locator` captures the logic of how to retrieve an element.\n\nIn the example below, handle points to a particular DOM element on page. If that element changes text or is used by\nReact to render an entirely different component, handle is still pointing to that very DOM element. This can lead\nto unexpected behaviors.\n\n```js\nconst handle = await page.$('text=Submit');\n// ...\nawait handle.hover();\nawait handle.click();\n```\n\n```java\nElementHandle handle = page.querySelector(\"text=Submit\");\nhandle.hover();\nhandle.click();\n```\n\n```py\nhandle = await page.query_selector(\"text=Submit\")\nawait handle.hover()\nawait handle.click()\n```\n\n```py\nhandle = page.query_selector(\"text=Submit\")\nhandle.hover()\nhandle.click()\n```\n\n```csharp\nvar handle = await page.QuerySelectorAsync(\"text=Submit\");\nawait handle.HoverAsync();\nawait handle.ClickAsync();\n```\n\nWith the locator, every time the `element` is used, up-to-date DOM element is located in the page using the\nselector. So in the snippet below, underlying DOM element is going to be located twice.\n\n```js\nconst locator = page.getByText('Submit');\n// ...\nawait locator.hover();\nawait locator.click();\n```\n\n```java\nLocator locator = page.getByText(\"Submit\");\nlocator.hover();\nlocator.click();\n```\n\n```py\nlocator = page.get_by_text(\"Submit\")\nawait locator.hover()\nawait locator.click()\n```\n\n```py\nlocator = page.get_by_text(\"Submit\")\nlocator.hover()\nlocator.click()\n```\n\n```csharp\nvar locator = page.GetByText(\"Submit\");\nawait locator.HoverAsync();\nawait locator.ClickAsync();\n```\n", + "since": "v1.8", + "members": [ + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "boundingBox", + "type": { + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "Object", + "properties": [ { "kind": "property", "langs": {}, "experimental": false, - "since": "v1.8", - "name": "channel", + "since": "v1.0", + "name": "x", "type": { - "name": "string", - "expression": "[string]" + "name": "float", + "expression": "[float]" }, "spec": [ { "type": "text", - "text": "Browser distribution channel. Supported values are \"chrome\", \"chrome-beta\", \"chrome-dev\", \"chrome-canary\", \"msedge\", \"msedge-beta\", \"msedge-dev\", \"msedge-canary\". Read more about using [Google Chrome and Microsoft Edge](../browsers.md#google-chrome--microsoft-edge)." + "text": "the x coordinate of the element in pixels." } ], - "required": false, - "comment": "Browser distribution channel. Supported values are \"chrome\", \"chrome-beta\", \"chrome-dev\", \"chrome-canary\", \"msedge\",\n\"msedge-beta\", \"msedge-dev\", \"msedge-canary\". Read more about using\n[Google Chrome and Microsoft Edge](../browsers.md#google-chrome--microsoft-edge).", - "deprecated": false, + "required": true, + "comment": "the x coordinate of the element in pixels.", "async": false, - "alias": "channel", + "alias": "x", "overloadIndex": 0, "paramOrOption": null }, @@ -25292,23 +34517,22 @@ "kind": "property", "langs": {}, "experimental": false, - "since": "v1.8", - "name": "chromiumSandbox", + "since": "v1.0", + "name": "y", "type": { - "name": "boolean", - "expression": "[boolean]" + "name": "float", + "expression": "[float]" }, "spec": [ { "type": "text", - "text": "Enable Chromium sandboxing. Defaults to `false`." + "text": "the y coordinate of the element in pixels." } ], - "required": false, - "comment": "Enable Chromium sandboxing. Defaults to `false`.", - "deprecated": false, + "required": true, + "comment": "the y coordinate of the element in pixels.", "async": false, - "alias": "chromiumSandbox", + "alias": "y", "overloadIndex": 0, "paramOrOption": null }, @@ -25316,34 +34540,22 @@ "kind": "property", "langs": {}, "experimental": false, - "since": "v1.8", - "name": "colorScheme", + "since": "v1.0", + "name": "width", "type": { - "name": "ColorScheme", - "union": [ - { - "name": "\"light\"" - }, - { - "name": "\"dark\"" - }, - { - "name": "\"no-preference\"" - } - ], - "expression": "[ColorScheme]<\"light\"|\"dark\"|\"no-preference\">" + "name": "float", + "expression": "[float]" }, "spec": [ { "type": "text", - "text": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See [`method: Page.emulateMedia`] for more details. Defaults to `'light'`." + "text": "the width of the element in pixels." } ], - "required": false, - "comment": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See\n[`method: Page.emulateMedia`] for more details. Defaults to `'light'`.", - "deprecated": false, + "required": true, + "comment": "the width of the element in pixels.", "async": false, - "alias": "colorScheme", + "alias": "width", "overloadIndex": 0, "paramOrOption": null }, @@ -25351,8 +34563,8 @@ "kind": "property", "langs": {}, "experimental": false, - "since": "v1.8", - "name": "deviceScaleFactor", + "since": "v1.0", + "name": "height", "type": { "name": "float", "expression": "[float]" @@ -25360,23 +34572,166 @@ "spec": [ { "type": "text", - "text": "Specify device scale factor (can be thought of as dpr). Defaults to `1`." + "text": "the height of the element in pixels." } ], - "required": false, - "comment": "Specify device scale factor (can be thought of as dpr). Defaults to `1`.", - "deprecated": false, + "required": true, + "comment": "the height of the element in pixels.", "async": false, - "alias": "deviceScaleFactor", + "alias": "height", "overloadIndex": 0, "paramOrOption": null - }, + } + ] + } + ], + "expression": "[null]|[Object]" + }, + "spec": [ + { + "type": "text", + "text": "This method returns the bounding box of the element, or `null` if the element is not visible. The bounding box is↵calculated relative to the main frame viewport - which is usually the same as the browser window." + }, + { + "type": "text", + "text": "Scrolling affects the returned bounding box, similarly to↵[Element.getBoundingClientRect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect). That↵means `x` and/or `y` may be negative." + }, + { + "type": "text", + "text": "Elements from child frames return the bounding box relative to the main frame, unlike the↵[Element.getBoundingClientRect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect)." + }, + { + "type": "text", + "text": "Assuming the page is static, it is safe to use bounding box coordinates to perform input. For example, the following↵snippet should click the center of the element." + }, + { + "type": "text", + "text": "**Usage**" + }, + { + "type": "code", + "lines": [ + "const box = await elementHandle.boundingBox();", + "await page.mouse.click(box.x + box.width / 2, box.y + box.height / 2);" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "BoundingBox box = elementHandle.boundingBox();", + "page.mouse().click(box.x + box.width / 2, box.y + box.height / 2);" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "box = await element_handle.bounding_box()", + "await page.mouse.click(box[\"x\"] + box[\"width\"] / 2, box[\"y\"] + box[\"height\"] / 2)" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "box = element_handle.bounding_box()", + "page.mouse.click(box[\"x\"] + box[\"width\"] / 2, box[\"y\"] + box[\"height\"] / 2)" + ], + "codeLang": "python sync" + }, + { + "type": "code", + "lines": [ + "var box = await elementHandle.BoundingBoxAsync();", + "await page.Mouse.ClickAsync(box.X + box.Width / 2, box.Y + box.Height / 2);" + ], + "codeLang": "csharp" + } + ], + "required": true, + "comment": "This method returns the bounding box of the element, or `null` if the element is not visible. The bounding box is\ncalculated relative to the main frame viewport - which is usually the same as the browser window.\n\nScrolling affects the returned bounding box, similarly to\n[Element.getBoundingClientRect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect).\nThat means `x` and/or `y` may be negative.\n\nElements from child frames return the bounding box relative to the main frame, unlike the\n[Element.getBoundingClientRect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect).\n\nAssuming the page is static, it is safe to use bounding box coordinates to perform input. For example, the\nfollowing snippet should click the center of the element.\n\n**Usage**\n\n```js\nconst box = await elementHandle.boundingBox();\nawait page.mouse.click(box.x + box.width / 2, box.y + box.height / 2);\n```\n\n```java\nBoundingBox box = elementHandle.boundingBox();\npage.mouse().click(box.x + box.width / 2, box.y + box.height / 2);\n```\n\n```py\nbox = await element_handle.bounding_box()\nawait page.mouse.click(box[\"x\"] + box[\"width\"] / 2, box[\"y\"] + box[\"height\"] / 2)\n```\n\n```py\nbox = element_handle.bounding_box()\npage.mouse.click(box[\"x\"] + box[\"width\"] / 2, box[\"y\"] + box[\"height\"] / 2)\n```\n\n```csharp\nvar box = await elementHandle.BoundingBoxAsync();\nawait page.Mouse.ClickAsync(box.X + box.Width / 2, box.Y + box.Height / 2);\n```\n", + "async": true, + "alias": "boundingBox", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "check", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "This method checks the element by performing the following steps:" + }, + { + "type": "li", + "text": "Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already↵checked, this method returns immediately.", + "liType": "ordinal" + }, + { + "type": "li", + "text": "Wait for [actionability](../actionability.md) checks on the element, unless `force` option is set.", + "liType": "ordinal" + }, + { + "type": "li", + "text": "Scroll the element into view if needed.", + "liType": "ordinal" + }, + { + "type": "li", + "text": "Use [`property: Page.mouse`] to click in the center of the element.", + "liType": "ordinal" + }, + { + "type": "li", + "text": "Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.", + "liType": "ordinal" + }, + { + "type": "li", + "text": "Ensure that the element is now checked. If not, this method throws.", + "liType": "ordinal" + }, + { + "type": "text", + "text": "If the element is detached from the DOM at any moment during the action, this method throws." + }, + { + "type": "text", + "text": "When all steps combined have not finished during the specified `timeout`, this method throws a↵`TimeoutError`. Passing zero timeout disables this." + } + ], + "required": true, + "comment": "This method checks the element by performing the following steps:\n1. Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already\n checked, this method returns immediately.\n1. Wait for [actionability](../actionability.md) checks on the element, unless `force` option is set.\n1. Scroll the element into view if needed.\n1. Use [`property: Page.mouse`] to click in the center of the element.\n1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.\n1. Ensure that the element is now checked. If not, this method throws.\n\nIf the element is detached from the DOM at any moment during the action, this method throws.\n\nWhen all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.\nPassing zero timeout disables this.", + "async": true, + "alias": "check", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "options", + "type": { + "name": "Object", + "properties": [ { "kind": "property", "langs": {}, "experimental": false, "since": "v1.8", - "name": "devtools", + "name": "force", "type": { "name": "boolean", "expression": "[boolean]" @@ -25384,14 +34739,13 @@ "spec": [ { "type": "text", - "text": "**Chromium-only** Whether to auto-open a Developer Tools panel for each tab. If this option is `true`, the `headless` option will be set `false`." + "text": "Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`." } ], "required": false, - "comment": "**Chromium-only** Whether to auto-open a Developer Tools panel for each tab. If this option is `true`, the `headless`\noption will be set `false`.", - "deprecated": false, + "comment": "Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.", "async": false, - "alias": "devtools", + "alias": "force", "overloadIndex": 0, "paramOrOption": null }, @@ -25400,62 +34754,92 @@ "langs": {}, "experimental": false, "since": "v1.8", - "name": "downloadsPath", + "name": "noWaitAfter", "type": { - "name": "path", - "expression": "[path]" + "name": "boolean", + "expression": "[boolean]" }, "spec": [ { "type": "text", - "text": "If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed. In either case, the downloads are deleted when the browser context they were created in is closed." + "text": "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`." } ], "required": false, - "comment": "If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is\ndeleted when browser is closed. In either case, the downloads are deleted when the browser context they were created in\nis closed.", - "deprecated": false, + "comment": "Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You\ncan opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as\nnavigating to inaccessible pages. Defaults to `false`.", "async": false, - "alias": "downloadsPath", + "alias": "noWaitAfter", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": { - "only": [ - "csharp", - "java" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, + "langs": {}, "experimental": false, - "since": "v1.8", - "name": "env", + "since": "v1.11", + "name": "position", "type": { "name": "Object", - "templates": [ + "properties": [ { - "name": "string" + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "x", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "x", + "overloadIndex": 0, + "paramOrOption": null }, { - "name": "string" + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "y", + "type": { + "name": "float", + "expression": "[float]" + }, + "spec": [ + { + "type": "text", + "text": "" + } + ], + "required": true, + "comment": "", + "async": false, + "alias": "y", + "overloadIndex": 0, + "paramOrOption": null } ], - "expression": "[Object]<[string], [string]>" + "expression": "[Object]" }, "spec": [ { "type": "text", - "text": "Specify environment variables that will be visible to the browser. Defaults to `process.env`." + "text": "A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the↵element." } ], "required": false, - "comment": "Specify environment variables that will be visible to the browser. Defaults to `process.env`.", - "deprecated": false, + "comment": "A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of\nthe element.", "async": false, - "alias": "env", + "alias": "position", "overloadIndex": 0, "paramOrOption": null }, @@ -25463,8 +34847,9 @@ "kind": "property", "langs": { "only": [ - "js", - "python" + "python", + "java", + "csharp" ], "aliases": {}, "types": {}, @@ -25472,97 +34857,51 @@ }, "experimental": false, "since": "v1.8", - "name": "env", + "name": "timeout", "type": { - "name": "Object", - "templates": [ - { - "name": "string" - }, - { - "name": "", - "union": [ - { - "name": "string" - }, - { - "name": "float" - }, - { - "name": "boolean" - } - ] - } - ], - "expression": "[Object]<[string], [string]|[float]|[boolean]>" + "name": "float", + "expression": "[float]" }, "spec": [ { "type": "text", - "text": "Specify environment variables that will be visible to the browser. Defaults to `process.env`." + "text": "Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by↵using the [`method: BrowserContext.setDefaultTimeout`] or↵[`method: Page.setDefaultTimeout`] methods." } ], "required": false, - "comment": "Specify environment variables that will be visible to the browser. Defaults to `process.env`.", - "deprecated": false, + "comment": "Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can\nbe changed by using the [`method: BrowserContext.setDefaultTimeout`] or [`method: Page.setDefaultTimeout`] methods.", "async": false, - "alias": "env", + "alias": "timeout", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "executablePath", - "type": { - "name": "path", - "expression": "[path]" + "langs": { + "only": [ + "js" + ], + "aliases": {}, + "types": {}, + "overrides": {} }, - "spec": [ - { - "type": "text", - "text": "Path to a browser executable to run instead of the bundled one. If `executablePath` is a relative path, then it is resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk." - } - ], - "required": false, - "comment": "Path to a browser executable to run instead of the bundled one. If `executablePath` is a relative path, then it is\nresolved relative to the current working directory. Note that Playwright only works with the bundled Chromium, Firefox\nor WebKit, use at your own risk.", - "deprecated": false, - "async": false, - "alias": "executablePath", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, "experimental": false, "since": "v1.8", - "name": "extraHTTPHeaders", + "name": "timeout", "type": { - "name": "Object", - "templates": [ - { - "name": "string" - }, - { - "name": "string" - } - ], - "expression": "[Object]<[string], [string]>" + "name": "float", + "expression": "[float]" }, "spec": [ { "type": "text", - "text": "An object containing additional HTTP headers to be sent with every request." + "text": "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 [`method: BrowserContext.setDefaultTimeout`] or↵[`method: Page.setDefaultTimeout`] methods." } ], "required": false, - "comment": "An object containing additional HTTP headers to be sent with every request.", - "deprecated": false, + "comment": "Maximum time in milliseconds. Defaults to `0` - no timeout. The default value can be changed via `actionTimeout`\noption in the config, or by using the [`method: BrowserContext.setDefaultTimeout`] or\n[`method: Page.setDefaultTimeout`] methods.", "async": false, - "alias": "extraHTTPHeaders", + "alias": "timeout", "overloadIndex": 0, "paramOrOption": null }, @@ -25570,129 +34909,126 @@ "kind": "property", "langs": {}, "experimental": false, - "since": "v1.8", - "name": "forcedColors", + "since": "v1.11", + "name": "trial", "type": { - "name": "ForcedColors", - "union": [ - { - "name": "\"active\"" - }, - { - "name": "\"none\"" - } - ], - "expression": "[ForcedColors]<\"active\"|\"none\">" + "name": "boolean", + "expression": "[boolean]" }, "spec": [ { "type": "text", - "text": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See [`method: Page.emulateMedia`] for more details. Defaults to `'none'`." - }, - { - "type": "note", - "noteType": "note", - "text": "It's not supported in WebKit, see [here](https://bugs.webkit.org/show_bug.cgi?id=225281) in their issue tracker." + "text": "When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults to `false`. Useful to wait until the element is ready for the action without performing it." } ], "required": false, - "comment": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See [`method: Page.emulateMedia`]\nfor more details. Defaults to `'none'`.\n\n> NOTE: It's not supported in WebKit, see [here](https://bugs.webkit.org/show_bug.cgi?id=225281) in their issue tracker.", - "deprecated": false, + "comment": "When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults\nto `false`. Useful to wait until the element is ready for the action without performing it.", "async": false, - "alias": "forcedColors", + "alias": "trial", "overloadIndex": 0, "paramOrOption": null - }, + } + ] + }, + "required": false, + "comment": "", + "async": false, + "alias": "options", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "click", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "This method clicks the element by performing the following steps:" + }, + { + "type": "li", + "text": "Wait for [actionability](../actionability.md) checks on the element, unless `force` option is set.", + "liType": "ordinal" + }, + { + "type": "li", + "text": "Scroll the element into view if needed.", + "liType": "ordinal" + }, + { + "type": "li", + "text": "Use [`property: Page.mouse`] to click in the center of the element, or the specified `position`.", + "liType": "ordinal" + }, + { + "type": "li", + "text": "Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.", + "liType": "ordinal" + }, + { + "type": "text", + "text": "If the element is detached from the DOM at any moment during the action, this method throws." + }, + { + "type": "text", + "text": "When all steps combined have not finished during the specified `timeout`, this method throws a↵`TimeoutError`. Passing zero timeout disables this." + } + ], + "required": true, + "comment": "This method clicks the element by performing the following steps:\n1. Wait for [actionability](../actionability.md) checks on the element, unless `force` option is set.\n1. Scroll the element into view if needed.\n1. Use [`property: Page.mouse`] to click in the center of the element, or the specified `position`.\n1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.\n\nIf the element is detached from the DOM at any moment during the action, this method throws.\n\nWhen all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.\nPassing zero timeout disables this.", + "async": true, + "alias": "click", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "options", + "type": { + "name": "Object", + "properties": [ { "kind": "property", "langs": {}, "experimental": false, "since": "v1.8", - "name": "geolocation", + "name": "button", "type": { - "name": "Object", - "properties": [ + "name": "MouseButton", + "union": [ { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "latitude", - "type": { - "name": "float", - "expression": "[float]" - }, - "spec": [ - { - "type": "text", - "text": "Latitude between -90 and 90." - } - ], - "required": true, - "comment": "Latitude between -90 and 90.", - "deprecated": false, - "async": false, - "alias": "latitude", - "overloadIndex": 0, - "paramOrOption": null + "name": "\"left\"" }, { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "longitude", - "type": { - "name": "float", - "expression": "[float]" - }, - "spec": [ - { - "type": "text", - "text": "Longitude between -180 and 180." - } - ], - "required": true, - "comment": "Longitude between -180 and 180.", - "deprecated": false, - "async": false, - "alias": "longitude", - "overloadIndex": 0, - "paramOrOption": null + "name": "\"right\"" }, { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "accuracy", - "type": { - "name": "float", - "expression": "[float]" - }, - "spec": [ - { - "type": "text", - "text": "Non-negative accuracy value. Defaults to `0`." - } - ], - "required": false, - "comment": "Non-negative accuracy value. Defaults to `0`.", - "deprecated": false, - "async": false, - "alias": "accuracy", - "overloadIndex": 0, - "paramOrOption": null + "name": "\"middle\"" } ], - "expression": "[Object]" + "expression": "[MouseButton]<\"left\"|\"right\"|\"middle\">" }, - "spec": [], + "spec": [ + { + "type": "text", + "text": "Defaults to `left`." + } + ], "required": false, - "comment": "", - "deprecated": false, + "comment": "Defaults to `left`.", "async": false, - "alias": "geolocation", + "alias": "button", "overloadIndex": 0, "paramOrOption": null }, @@ -25701,22 +35037,21 @@ "langs": {}, "experimental": false, "since": "v1.8", - "name": "handleSIGHUP", + "name": "clickCount", "type": { - "name": "boolean", - "expression": "[boolean]" + "name": "int", + "expression": "[int]" }, "spec": [ { "type": "text", - "text": "Close the browser process on SIGHUP. Defaults to `true`." + "text": "defaults to 1. See [UIEvent.detail]." } ], "required": false, - "comment": "Close the browser process on SIGHUP. Defaults to `true`.", - "deprecated": false, + "comment": "defaults to 1. See [UIEvent.detail].", "async": false, - "alias": "handleSIGHUP", + "alias": "clickCount", "overloadIndex": 0, "paramOrOption": null }, @@ -25725,22 +35060,21 @@ "langs": {}, "experimental": false, "since": "v1.8", - "name": "handleSIGINT", + "name": "delay", "type": { - "name": "boolean", - "expression": "[boolean]" + "name": "float", + "expression": "[float]" }, "spec": [ { "type": "text", - "text": "Close the browser process on Ctrl-C. Defaults to `true`." + "text": "Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0." } ], "required": false, - "comment": "Close the browser process on Ctrl-C. Defaults to `true`.", - "deprecated": false, + "comment": "Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.", "async": false, - "alias": "handleSIGINT", + "alias": "delay", "overloadIndex": 0, "paramOrOption": null }, @@ -25749,7 +35083,7 @@ "langs": {}, "experimental": false, "since": "v1.8", - "name": "handleSIGTERM", + "name": "force", "type": { "name": "boolean", "expression": "[boolean]" @@ -25757,14 +35091,13 @@ "spec": [ { "type": "text", - "text": "Close the browser process on SIGTERM. Defaults to `true`." + "text": "Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`." } ], "required": false, - "comment": "Close the browser process on SIGTERM. Defaults to `true`.", - "deprecated": false, + "comment": "Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.", "async": false, - "alias": "handleSIGTERM", + "alias": "force", "overloadIndex": 0, "paramOrOption": null }, @@ -25773,22 +35106,40 @@ "langs": {}, "experimental": false, "since": "v1.8", - "name": "hasTouch", + "name": "modifiers", "type": { - "name": "boolean", - "expression": "[boolean]" + "name": "Array", + "templates": [ + { + "name": "KeyboardModifier", + "union": [ + { + "name": "\"Alt\"" + }, + { + "name": "\"Control\"" + }, + { + "name": "\"Meta\"" + }, + { + "name": "\"Shift\"" + } + ] + } + ], + "expression": "[Array]<[KeyboardModifier]<\"Alt\"|\"Control\"|\"Meta\"|\"Shift\">>" }, "spec": [ { "type": "text", - "text": "Specifies if viewport supports touch events. Defaults to false." + "text": "Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current↵modifiers back. If not specified, currently pressed modifiers are used." } ], "required": false, - "comment": "Specifies if viewport supports touch events. Defaults to false.", - "deprecated": false, + "comment": "Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores\ncurrent modifiers back. If not specified, currently pressed modifiers are used.", "async": false, - "alias": "hasTouch", + "alias": "modifiers", "overloadIndex": 0, "paramOrOption": null }, @@ -25797,7 +35148,7 @@ "langs": {}, "experimental": false, "since": "v1.8", - "name": "headless", + "name": "noWaitAfter", "type": { "name": "boolean", "expression": "[boolean]" @@ -25805,14 +35156,13 @@ "spec": [ { "type": "text", - "text": "Whether to run browser in headless mode. More details for [Chromium](https://developers.google.com/web/updates/2017/04/headless-chrome) and [Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Firefox/Headless_mode). Defaults to `true` unless the `devtools` option is `true`." + "text": "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`." } ], "required": false, - "comment": "Whether to run browser in headless mode. More details for\n[Chromium](https://developers.google.com/web/updates/2017/04/headless-chrome) and\n[Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Firefox/Headless_mode). Defaults to `true` unless the\n`devtools` option is `true`.", - "deprecated": false, + "comment": "Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You\ncan opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as\nnavigating to inaccessible pages. Defaults to `false`.", "async": false, - "alias": "headless", + "alias": "noWaitAfter", "overloadIndex": 0, "paramOrOption": null }, @@ -25821,7 +35171,7 @@ "langs": {}, "experimental": false, "since": "v1.8", - "name": "httpCredentials", + "name": "position", "type": { "name": "Object", "properties": [ @@ -25830,10 +35180,10 @@ "langs": {}, "experimental": false, "since": "v1.0", - "name": "username", + "name": "x", "type": { - "name": "string", - "expression": "[string]" + "name": "float", + "expression": "[float]" }, "spec": [ { @@ -25843,9 +35193,8 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, - "alias": "username", + "alias": "x", "overloadIndex": 0, "paramOrOption": null }, @@ -25854,10 +35203,10 @@ "langs": {}, "experimental": false, "since": "v1.0", - "name": "password", + "name": "y", "type": { - "name": "string", - "expression": "[string]" + "name": "float", + "expression": "[float]" }, "spec": [ { @@ -25867,9 +35216,8 @@ ], "required": true, "comment": "", - "deprecated": false, "async": false, - "alias": "password", + "alias": "y", "overloadIndex": 0, "paramOrOption": null } @@ -25879,46 +35227,13 @@ "spec": [ { "type": "text", - "text": "Credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)." - } - ], - "required": false, - "comment": "Credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication).", - "deprecated": false, - "async": false, - "alias": "httpCredentials", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": { - "only": [ - "csharp", - "java" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.9", - "name": "ignoreAllDefaultArgs", - "type": { - "name": "boolean", - "expression": "[boolean]" - }, - "spec": [ - { - "type": "text", - "text": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. Dangerous option; use with care. Defaults to `false`." + "text": "A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the↵element." } ], "required": false, - "comment": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. Dangerous option;\nuse with care. Defaults to `false`.", - "deprecated": false, + "comment": "A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of\nthe element.", "async": false, - "alias": "ignoreAllDefaultArgs", + "alias": "position", "overloadIndex": 0, "paramOrOption": null }, @@ -25926,8 +35241,9 @@ "kind": "property", "langs": { "only": [ - "js", - "python" + "python", + "java", + "csharp" ], "aliases": {}, "types": {}, @@ -25935,35 +35251,21 @@ }, "experimental": false, "since": "v1.8", - "name": "ignoreDefaultArgs", + "name": "timeout", "type": { - "name": "", - "union": [ - { - "name": "boolean" - }, - { - "name": "Array", - "templates": [ - { - "name": "string" - } - ] - } - ], - "expression": "[boolean]|[Array]<[string]>" + "name": "float", + "expression": "[float]" }, "spec": [ { "type": "text", - "text": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. If an array is given, then filters out the given default arguments. Dangerous option; use with care. Defaults to `false`." + "text": "Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by↵using the [`method: BrowserContext.setDefaultTimeout`] or↵[`method: Page.setDefaultTimeout`] methods." } ], "required": false, - "comment": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. If an array is\ngiven, then filters out the given default arguments. Dangerous option; use with care. Defaults to `false`.", - "deprecated": false, + "comment": "Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can\nbe changed by using the [`method: BrowserContext.setDefaultTimeout`] or [`method: Page.setDefaultTimeout`] methods.", "async": false, - "alias": "ignoreDefaultArgs", + "alias": "timeout", "overloadIndex": 0, "paramOrOption": null }, @@ -25971,8 +35273,7 @@ "kind": "property", "langs": { "only": [ - "csharp", - "java" + "js" ], "aliases": {}, "types": {}, @@ -25980,75 +35281,21 @@ }, "experimental": false, "since": "v1.8", - "name": "ignoreDefaultArgs", - "type": { - "name": "Array", - "templates": [ - { - "name": "string" - } - ], - "expression": "[Array]<[string]>" - }, - "spec": [ - { - "type": "text", - "text": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. Dangerous option; use with care." - } - ], - "required": false, - "comment": "If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. Dangerous option;\nuse with care.", - "deprecated": false, - "async": false, - "alias": "ignoreDefaultArgs", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "ignoreHTTPSErrors", - "type": { - "name": "boolean", - "expression": "[boolean]" - }, - "spec": [ - { - "type": "text", - "text": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`." - } - ], - "required": false, - "comment": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.", - "deprecated": false, - "async": false, - "alias": "ignoreHTTPSErrors", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.8", - "name": "isMobile", + "name": "timeout", "type": { - "name": "boolean", - "expression": "[boolean]" + "name": "float", + "expression": "[float]" }, "spec": [ { "type": "text", - "text": "Whether the `meta viewport` tag is taken into account and touch events are enabled. Defaults to `false`. Not supported in Firefox." + "text": "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 [`method: BrowserContext.setDefaultTimeout`] or↵[`method: Page.setDefaultTimeout`] methods." } ], "required": false, - "comment": "Whether the `meta viewport` tag is taken into account and touch events are enabled. Defaults to `false`. Not supported\nin Firefox.", - "deprecated": false, + "comment": "Maximum time in milliseconds. Defaults to `0` - no timeout. The default value can be changed via `actionTimeout`\noption in the config, or by using the [`method: BrowserContext.setDefaultTimeout`] or\n[`method: Page.setDefaultTimeout`] methods.", "async": false, - "alias": "isMobile", + "alias": "timeout", "overloadIndex": 0, "paramOrOption": null }, @@ -26056,8 +35303,8 @@ "kind": "property", "langs": {}, "experimental": false, - "since": "v1.8", - "name": "javaScriptEnabled", + "since": "v1.11", + "name": "trial", "type": { "name": "boolean", "expression": "[boolean]" @@ -26065,100 +35312,183 @@ "spec": [ { "type": "text", - "text": "Whether or not to enable JavaScript in the context. Defaults to `true`." + "text": "When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults to `false`. Useful to wait until the element is ready for the action without performing it." } ], "required": false, - "comment": "Whether or not to enable JavaScript in the context. Defaults to `true`.", - "deprecated": false, + "comment": "When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults\nto `false`. Useful to wait until the element is ready for the action without performing it.", "async": false, - "alias": "javaScriptEnabled", + "alias": "trial", "overloadIndex": 0, "paramOrOption": null - }, + } + ] + }, + "required": false, + "comment": "", + "async": false, + "alias": "options", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "contentFrame", + "type": { + "name": "", + "union": [ + { + "name": "null" + }, + { + "name": "Frame" + } + ], + "expression": "[null]|[Frame]" + }, + "spec": [ + { + "type": "text", + "text": "Returns the content frame for element handles referencing iframe nodes, or `null` otherwise" + } + ], + "required": true, + "comment": "Returns the content frame for element handles referencing iframe nodes, or `null` otherwise", + "async": true, + "alias": "contentFrame", + "overloadIndex": 0, + "paramOrOption": null, + "args": [] + }, + { + "kind": "method", + "langs": { + "aliases": { + "csharp": "DblClickAsync" + }, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.8", + "name": "dblclick", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "This method double clicks the element by performing the following steps:" + }, + { + "type": "li", + "text": "Wait for [actionability](../actionability.md) checks on the element, unless `force` option is set.", + "liType": "ordinal" + }, + { + "type": "li", + "text": "Scroll the element into view if needed.", + "liType": "ordinal" + }, + { + "type": "li", + "text": "Use [`property: Page.mouse`] to double click in the center of the element, or the specified `position`.", + "liType": "ordinal" + }, + { + "type": "li", + "text": "Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. Note that↵if the first click of the `dblclick()` triggers a navigation event, this method will throw.", + "liType": "ordinal" + }, + { + "type": "text", + "text": "If the element is detached from the DOM at any moment during the action, this method throws." + }, + { + "type": "text", + "text": "When all steps combined have not finished during the specified `timeout`, this method throws a↵`TimeoutError`. Passing zero timeout disables this." + }, + { + "type": "note", + "noteType": "note", + "text": "`elementHandle.dblclick()` dispatches two `click` events and a single `dblclick` event." + } + ], + "required": true, + "comment": "This method double clicks the element by performing the following steps:\n1. Wait for [actionability](../actionability.md) checks on the element, unless `force` option is set.\n1. Scroll the element into view if needed.\n1. Use [`property: Page.mouse`] to double click in the center of the element, or the specified `position`.\n1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. Note that if\n the first click of the `dblclick()` triggers a navigation event, this method will throw.\n\nIf the element is detached from the DOM at any moment during the action, this method throws.\n\nWhen all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.\nPassing zero timeout disables this.\n\n**NOTE** `elementHandle.dblclick()` dispatches two `click` events and a single `dblclick` event.", + "async": true, + "alias": "dblclick", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.0", + "name": "options", + "type": { + "name": "Object", + "properties": [ { "kind": "property", "langs": {}, "experimental": false, "since": "v1.8", - "name": "locale", + "name": "button", "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value, `Accept-Language` request header value as well as number and date formatting rules." - } - ], - "required": false, - "comment": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value, `Accept-Language`\nrequest header value as well as number and date formatting rules.", - "deprecated": false, - "async": false, - "alias": "locale", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": { - "only": [ - "js" + "name": "MouseButton", + "union": [ + { + "name": "\"left\"" + }, + { + "name": "\"right\"" + }, + { + "name": "\"middle\"" + } ], - "aliases": {}, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.8", - "name": "logger", - "type": { - "name": "Logger", - "expression": "[Logger]" + "expression": "[MouseButton]<\"left\"|\"right\"|\"middle\">" }, "spec": [ { "type": "text", - "text": "Logger sink for Playwright logging." + "text": "Defaults to `left`." } ], "required": false, - "comment": "Logger sink for Playwright logging.", - "deprecated": false, + "comment": "Defaults to `left`.", "async": false, - "alias": "logger", + "alias": "button", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": { - "only": [ - "python" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, + "langs": {}, "experimental": false, "since": "v1.8", - "name": "noViewport", + "name": "delay", "type": { - "name": "boolean", - "expression": "[boolean]" + "name": "float", + "expression": "[float]" }, "spec": [ { "type": "text", - "text": "Does not enforce fixed viewport, allows resizing window in the headed mode." + "text": "Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0." } ], "required": false, - "comment": "Does not enforce fixed viewport, allows resizing window in the headed mode.", - "deprecated": false, + "comment": "Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.", "async": false, - "alias": "noViewport", + "alias": "delay", "overloadIndex": 0, "paramOrOption": null }, @@ -26167,7 +35497,7 @@ "langs": {}, "experimental": false, "since": "v1.8", - "name": "offline", + "name": "force", "type": { "name": "boolean", "expression": "[boolean]" @@ -26175,14 +35505,13 @@ "spec": [ { "type": "text", - "text": "Whether to emulate network being offline. Defaults to `false`." + "text": "Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`." } ], "required": false, - "comment": "Whether to emulate network being offline. Defaults to `false`.", - "deprecated": false, + "comment": "Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.", "async": false, - "alias": "offline", + "alias": "force", "overloadIndex": 0, "paramOrOption": null }, @@ -26191,27 +35520,40 @@ "langs": {}, "experimental": false, "since": "v1.8", - "name": "permissions", + "name": "modifiers", "type": { "name": "Array", "templates": [ { - "name": "string" + "name": "KeyboardModifier", + "union": [ + { + "name": "\"Alt\"" + }, + { + "name": "\"Control\"" + }, + { + "name": "\"Meta\"" + }, + { + "name": "\"Shift\"" + } + ] } ], - "expression": "[Array]<[string]>" + "expression": "[Array]<[KeyboardModifier]<\"Alt\"|\"Control\"|\"Meta\"|\"Shift\">>" }, "spec": [ { "type": "text", - "text": "A list of permissions to grant to all pages in this context. See [`method: BrowserContext.grantPermissions`] for more details." + "text": "Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current↵modifiers back. If not specified, currently pressed modifiers are used." } ], "required": false, - "comment": "A list of permissions to grant to all pages in this context. See [`method: BrowserContext.grantPermissions`] for more\ndetails.", - "deprecated": false, + "comment": "Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores\ncurrent modifiers back. If not specified, currently pressed modifiers are used.", "async": false, - "alias": "permissions", + "alias": "modifiers", "overloadIndex": 0, "paramOrOption": null }, @@ -26220,136 +35562,30 @@ "langs": {}, "experimental": false, "since": "v1.8", - "name": "proxy", + "name": "noWaitAfter", "type": { - "name": "Object", - "properties": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "server", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example `http://myproxy.com:3128` or `socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP proxy." - } - ], - "required": true, - "comment": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example `http://myproxy.com:3128` or\n`socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP proxy.", - "deprecated": false, - "async": false, - "alias": "server", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "bypass", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "Optional comma-separated domains to bypass proxy, for example `\".com, chromium.org, .domain.com\"`." - } - ], - "required": false, - "comment": "Optional comma-separated domains to bypass proxy, for example `\".com, chromium.org, .domain.com\"`.", - "deprecated": false, - "async": false, - "alias": "bypass", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "username", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "Optional username to use if HTTP proxy requires authentication." - } - ], - "required": false, - "comment": "Optional username to use if HTTP proxy requires authentication.", - "deprecated": false, - "async": false, - "alias": "username", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "password", - "type": { - "name": "string", - "expression": "[string]" - }, - "spec": [ - { - "type": "text", - "text": "Optional password to use if HTTP proxy requires authentication." - } - ], - "required": false, - "comment": "Optional password to use if HTTP proxy requires authentication.", - "deprecated": false, - "async": false, - "alias": "password", - "overloadIndex": 0, - "paramOrOption": null - } - ], - "expression": "[Object]" + "name": "boolean", + "expression": "[boolean]" }, "spec": [ { "type": "text", - "text": "Network proxy settings." + "text": "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`." } ], "required": false, - "comment": "Network proxy settings.", - "deprecated": false, + "comment": "Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You\ncan opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as\nnavigating to inaccessible pages. Defaults to `false`.", "async": false, - "alias": "proxy", + "alias": "noWaitAfter", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": { - "only": [ - "js" - ], - "aliases": {}, - "types": {}, - "overrides": {} - }, + "langs": {}, "experimental": false, "since": "v1.8", - "name": "recordHar", + "name": "position", "type": { "name": "Object", "properties": [ @@ -26358,113 +35594,21 @@ "langs": {}, "experimental": false, "since": "v1.0", - "name": "omitContent", - "type": { - "name": "boolean", - "expression": "[boolean]" - }, - "spec": [ - { - "type": "text", - "text": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`. Deprecated, use `content` policy instead." - } - ], - "required": false, - "comment": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`. Deprecated, use `content`\npolicy instead.", - "deprecated": false, - "async": false, - "alias": "omitContent", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "content", - "type": { - "name": "HarContentPolicy", - "union": [ - { - "name": "\"omit\"" - }, - { - "name": "\"embed\"" - }, - { - "name": "\"attach\"" - } - ], - "expression": "[HarContentPolicy]<\"omit\"|\"embed\"|\"attach\">" - }, - "spec": [ - { - "type": "text", - "text": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach` is specified, resources are persistet as separate files or entries in the ZIP archive. If `embed` is specified, content is stored inline the HAR file as per HAR specification. Defaults to `attach` for `.zip` output files and to `embed` for all other file extensions." - } - ], - "required": false, - "comment": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach`\nis specified, resources are persistet as separate files or entries in the ZIP archive. If `embed` is specified, content\nis stored inline the HAR file as per HAR specification. Defaults to `attach` for `.zip` output files and to `embed` for\nall other file extensions.", - "deprecated": false, - "async": false, - "alias": "content", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "path", + "name": "x", "type": { - "name": "path", - "expression": "[path]" + "name": "float", + "expression": "[float]" }, "spec": [ { "type": "text", - "text": "Path on the filesystem to write the HAR file to. If the file name ends with `.zip`, `content: 'attach'` is used by default." + "text": "" } ], "required": true, - "comment": "Path on the filesystem to write the HAR file to. If the file name ends with `.zip`, `content: 'attach'` is used by\ndefault.", - "deprecated": false, - "async": false, - "alias": "path", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "mode", - "type": { - "name": "HarMode", - "union": [ - { - "name": "\"full\"" - }, - { - "name": "\"minimal\"" - } - ], - "expression": "[HarMode]<\"full\"|\"minimal\">" - }, - "spec": [ - { - "type": "text", - "text": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to `full`." - } - ], - "required": false, - "comment": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies,\nsecurity and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.", - "deprecated": false, + "comment": "", "async": false, - "alias": "mode", + "alias": "x", "overloadIndex": 0, "paramOrOption": null }, @@ -26473,30 +35617,21 @@ "langs": {}, "experimental": false, "since": "v1.0", - "name": "urlFilter", + "name": "y", "type": { - "name": "", - "union": [ - { - "name": "string" - }, - { - "name": "RegExp" - } - ], - "expression": "[string]|[RegExp]" + "name": "float", + "expression": "[float]" }, "spec": [ { "type": "text", - "text": "A glob or regex pattern to filter requests that are stored in the HAR. When a `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." + "text": "" } ], - "required": false, - "comment": "A glob or regex pattern to filter requests that are stored in the HAR. When a `baseURL` via the context options was\nprovided and the passed URL is a path, it gets merged via the\n[`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor.", - "deprecated": false, + "required": true, + "comment": "", "async": false, - "alias": "urlFilter", + "alias": "y", "overloadIndex": 0, "paramOrOption": null } @@ -26506,14 +35641,13 @@ "spec": [ { "type": "text", - "text": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into `recordHar.path` file. If not specified, the HAR is not recorded. Make sure to await [`method: BrowserContext.close`] for the HAR to be saved." + "text": "A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the↵element." } ], "required": false, - "comment": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into `recordHar.path` file. If not\nspecified, the HAR is not recorded. Make sure to await [`method: BrowserContext.close`] for the HAR to be saved.", - "deprecated": false, + "comment": "A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of\nthe element.", "async": false, - "alias": "recordHar", + "alias": "position", "overloadIndex": 0, "paramOrOption": null }, @@ -26521,45 +35655,31 @@ "kind": "property", "langs": { "only": [ - "csharp", + "python", "java", - "python" + "csharp" ], - "aliases": { - "python": "record_har_content" - }, + "aliases": {}, "types": {}, "overrides": {} }, "experimental": false, "since": "v1.8", - "name": "recordHarContent", + "name": "timeout", "type": { - "name": "HarContentPolicy", - "union": [ - { - "name": "\"omit\"" - }, - { - "name": "\"embed\"" - }, - { - "name": "\"attach\"" - } - ], - "expression": "[HarContentPolicy]<\"omit\"|\"embed\"|\"attach\">" + "name": "float", + "expression": "[float]" }, "spec": [ { "type": "text", - "text": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach` is specified, resources are persistet as separate files and all of these files are archived along with the HAR file. Defaults to `embed`, which stores content inline the HAR file as per HAR specification." + "text": "Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by↵using the [`method: BrowserContext.setDefaultTimeout`] or↵[`method: Page.setDefaultTimeout`] methods." } ], "required": false, - "comment": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If `attach`\nis specified, resources are persistet as separate files and all of these files are archived along with the HAR file.\nDefaults to `embed`, which stores content inline the HAR file as per HAR specification.", - "deprecated": false, + "comment": "Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can\nbe changed by using the [`method: BrowserContext.setDefaultTimeout`] or [`method: Page.setDefaultTimeout`] methods.", "async": false, - "alias": "recordHarContent", + "alias": "timeout", "overloadIndex": 0, "paramOrOption": null }, @@ -26567,62 +35687,38 @@ "kind": "property", "langs": { "only": [ - "csharp", - "java", - "python" + "js" ], - "aliases": { - "python": "record_har_mode" - }, + "aliases": {}, "types": {}, "overrides": {} }, "experimental": false, "since": "v1.8", - "name": "recordHarMode", + "name": "timeout", "type": { - "name": "HarMode", - "union": [ - { - "name": "\"full\"" - }, - { - "name": "\"minimal\"" - } - ], - "expression": "[HarMode]<\"full\"|\"minimal\">" + "name": "float", + "expression": "[float]" }, "spec": [ { "type": "text", - "text": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to `full`." + "text": "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 [`method: BrowserContext.setDefaultTimeout`] or↵[`method: Page.setDefaultTimeout`] methods." } ], "required": false, - "comment": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies,\nsecurity and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.", - "deprecated": false, + "comment": "Maximum time in milliseconds. Defaults to `0` - no timeout. The default value can be changed via `actionTimeout`\noption in the config, or by using the [`method: BrowserContext.setDefaultTimeout`] or\n[`method: Page.setDefaultTimeout`] methods.", "async": false, - "alias": "recordHarMode", + "alias": "timeout", "overloadIndex": 0, "paramOrOption": null }, { "kind": "property", - "langs": { - "only": [ - "csharp", - "java", - "python" - ], - "aliases": { - "python": "record_har_omit_content" - }, - "types": {}, - "overrides": {} - }, + "langs": {}, "experimental": false, - "since": "v1.8", - "name": "recordHarOmitContent", + "since": "v1.11", + "name": "trial", "type": { "name": "boolean", "expression": "[boolean]" @@ -26630,91 +35726,347 @@ "spec": [ { "type": "text", - "text": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`." - } - ], - "required": false, - "comment": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`.", - "deprecated": false, - "async": false, - "alias": "recordHarOmitContent", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": { - "only": [ - "csharp", - "java", - "python" - ], - "aliases": { - "python": "record_har_path" - }, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.8", - "name": "recordHarPath", - "type": { - "name": "path", - "expression": "[path]" - }, - "spec": [ - { - "type": "text", - "text": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the specified HAR file on the filesystem. If not specified, the HAR is not recorded. Make sure to call [`method: BrowserContext.close`] for the HAR to be saved." + "text": "When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults to `false`. Useful to wait until the element is ready for the action without performing it." } ], "required": false, - "comment": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the specified HAR file on the\nfilesystem. If not specified, the HAR is not recorded. Make sure to call [`method: BrowserContext.close`] for the HAR to\nbe saved.", - "deprecated": false, - "async": false, - "alias": "recordHarPath", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": { - "only": [ - "csharp", - "java", - "python" - ], - "aliases": { - "python": "record_har_url_filter" - }, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.8", - "name": "recordHarUrlFilter", - "type": { - "name": "", - "union": [ - { - "name": "string" - }, - { - "name": "RegExp" - } - ], - "expression": "[string]|[RegExp]" - }, - "spec": [], - "required": false, - "comment": "", - "deprecated": false, + "comment": "When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults\nto `false`. Useful to wait until the element is ready for the action without performing it.", "async": false, - "alias": "recordHarUrlFilter", + "alias": "trial", "overloadIndex": 0, "paramOrOption": null - }, - { + } + ] + }, + "required": false, + "comment": "", + "async": false, + "alias": "options", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "dispatchEvent", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "The snippet below dispatches the `click` event on the element. Regardless of the visibility state of the element, `click`↵is dispatched. This is equivalent to calling↵[element.click()](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/click)." + }, + { + "type": "text", + "text": "**Usage**" + }, + { + "type": "code", + "lines": [ + "await elementHandle.dispatchEvent('click');" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "elementHandle.dispatchEvent(\"click\");" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "await element_handle.dispatch_event(\"click\")" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "element_handle.dispatch_event(\"click\")" + ], + "codeLang": "python sync" + }, + { + "type": "code", + "lines": [ + "await elementHandle.DispatchEventAsync(\"click\");" + ], + "codeLang": "csharp" + }, + { + "type": "text", + "text": "Under the hood, it creates an instance of an event based on the given `type`, initializes it with↵`eventInit` properties and dispatches it on the element. Events are `composed`, `cancelable` and bubble by↵default." + }, + { + "type": "text", + "text": "Since `eventInit` is event-specific, please refer to the events documentation for the lists of initial↵properties:" + }, + { + "type": "li", + "text": "[DragEvent](https://developer.mozilla.org/en-US/docs/Web/API/DragEvent/DragEvent)", + "liType": "bullet" + }, + { + "type": "li", + "text": "[FocusEvent](https://developer.mozilla.org/en-US/docs/Web/API/FocusEvent/FocusEvent)", + "liType": "bullet" + }, + { + "type": "li", + "text": "[KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/KeyboardEvent)", + "liType": "bullet" + }, + { + "type": "li", + "text": "[MouseEvent](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/MouseEvent)", + "liType": "bullet" + }, + { + "type": "li", + "text": "[PointerEvent](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/PointerEvent)", + "liType": "bullet" + }, + { + "type": "li", + "text": "[TouchEvent](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent/TouchEvent)", + "liType": "bullet" + }, + { + "type": "li", + "text": "[Event](https://developer.mozilla.org/en-US/docs/Web/API/Event/Event)", + "liType": "bullet" + }, + { + "type": "text", + "text": "You can also specify `JSHandle` as the property value if you want live objects to be passed into the event:" + }, + { + "type": "code", + "lines": [ + "// Note you can only create DataTransfer in Chromium and Firefox", + "const dataTransfer = await page.evaluateHandle(() => new DataTransfer());", + "await elementHandle.dispatchEvent('dragstart', { dataTransfer });" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "// Note you can only create DataTransfer in Chromium and Firefox", + "JSHandle dataTransfer = page.evaluateHandle(\"() => new DataTransfer()\");", + "Map arg = new HashMap<>();", + "arg.put(\"dataTransfer\", dataTransfer);", + "elementHandle.dispatchEvent(\"dragstart\", arg);" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "# note you can only create data_transfer in chromium and firefox", + "data_transfer = await page.evaluate_handle(\"new DataTransfer()\")", + "await element_handle.dispatch_event(\"#source\", \"dragstart\", {\"dataTransfer\": data_transfer})" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "# note you can only create data_transfer in chromium and firefox", + "data_transfer = page.evaluate_handle(\"new DataTransfer()\")", + "element_handle.dispatch_event(\"#source\", \"dragstart\", {\"dataTransfer\": data_transfer})" + ], + "codeLang": "python sync" + }, + { + "type": "code", + "lines": [ + "var dataTransfer = await page.EvaluateHandleAsync(\"() => new DataTransfer()\");", + "await elementHandle.DispatchEventAsync(\"dragstart\", new Dictionary", + "{", + " { \"dataTransfer\", dataTransfer }", + "});" + ], + "codeLang": "csharp" + } + ], + "required": true, + "comment": "The snippet below dispatches the `click` event on the element. Regardless of the visibility state of the element,\n`click` is dispatched. This is equivalent to calling\n[element.click()](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/click).\n\n**Usage**\n\n```js\nawait elementHandle.dispatchEvent('click');\n```\n\n```java\nelementHandle.dispatchEvent(\"click\");\n```\n\n```py\nawait element_handle.dispatch_event(\"click\")\n```\n\n```py\nelement_handle.dispatch_event(\"click\")\n```\n\n```csharp\nawait elementHandle.DispatchEventAsync(\"click\");\n```\n\nUnder the hood, it creates an instance of an event based on the given `type`, initializes it with `eventInit`\nproperties and dispatches it on the element. Events are `composed`, `cancelable` and bubble by default.\n\nSince `eventInit` is event-specific, please refer to the events documentation for the lists of initial properties:\n- [DragEvent](https://developer.mozilla.org/en-US/docs/Web/API/DragEvent/DragEvent)\n- [FocusEvent](https://developer.mozilla.org/en-US/docs/Web/API/FocusEvent/FocusEvent)\n- [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/KeyboardEvent)\n- [MouseEvent](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/MouseEvent)\n- [PointerEvent](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/PointerEvent)\n- [TouchEvent](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent/TouchEvent)\n- [Event](https://developer.mozilla.org/en-US/docs/Web/API/Event/Event)\n\nYou can also specify `JSHandle` as the property value if you want live objects to be passed into the event:\n\n```js\n// Note you can only create DataTransfer in Chromium and Firefox\nconst dataTransfer = await page.evaluateHandle(() => new DataTransfer());\nawait elementHandle.dispatchEvent('dragstart', { dataTransfer });\n```\n\n```java\n// Note you can only create DataTransfer in Chromium and Firefox\nJSHandle dataTransfer = page.evaluateHandle(\"() => new DataTransfer()\");\nMap arg = new HashMap<>();\narg.put(\"dataTransfer\", dataTransfer);\nelementHandle.dispatchEvent(\"dragstart\", arg);\n```\n\n```py\n# note you can only create data_transfer in chromium and firefox\ndata_transfer = await page.evaluate_handle(\"new DataTransfer()\")\nawait element_handle.dispatch_event(\"#source\", \"dragstart\", {\"dataTransfer\": data_transfer})\n```\n\n```py\n# note you can only create data_transfer in chromium and firefox\ndata_transfer = page.evaluate_handle(\"new DataTransfer()\")\nelement_handle.dispatch_event(\"#source\", \"dragstart\", {\"dataTransfer\": data_transfer})\n```\n\n```csharp\nvar dataTransfer = await page.EvaluateHandleAsync(\"() => new DataTransfer()\");\nawait elementHandle.DispatchEventAsync(\"dragstart\", new Dictionary\n{\n { \"dataTransfer\", dataTransfer }\n});\n```\n", + "async": true, + "alias": "dispatchEvent", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "type", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "DOM event type: `\"click\"`, `\"dragstart\"`, etc." + } + ], + "required": true, + "comment": "DOM event type: `\"click\"`, `\"dragstart\"`, etc.", + "async": false, + "alias": "type", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "eventInit", + "type": { + "name": "EvaluationArgument", + "expression": "[EvaluationArgument]" + }, + "spec": [ + { + "type": "text", + "text": "Optional event-specific initialization properties." + } + ], + "required": false, + "comment": "Optional event-specific initialization properties.", + "async": false, + "alias": "eventInit", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": { + "aliases": { + "python": "eval_on_selector", + "js": "$eval" + }, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.9", + "name": "evalOnSelector", + "type": { + "name": "Serializable", + "expression": "[Serializable]" + }, + "spec": [ + { + "type": "text", + "text": "Returns the return value of `expression`." + }, + { + "type": "text", + "text": "The method finds an element matching the specified selector in the `ElementHandle`s subtree and passes it as a first↵argument to `expression`. If no elements match the selector, the method throws an error." + }, + { + "type": "text", + "text": "If `expression` returns a [Promise], then [`method: ElementHandle.evalOnSelector`] would wait for the promise to resolve and return its↵value." + }, + { + "type": "text", + "text": "**Usage**" + }, + { + "type": "code", + "lines": [ + "const tweetHandle = await page.$('.tweet');", + "expect(await tweetHandle.$eval('.like', node => node.innerText)).toBe('100');", + "expect(await tweetHandle.$eval('.retweets', node => node.innerText)).toBe('10');" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "ElementHandle tweetHandle = page.querySelector(\".tweet\");", + "assertEquals(\"100\", tweetHandle.evalOnSelector(\".like\", \"node => node.innerText\"));", + "assertEquals(\"10\", tweetHandle.evalOnSelector(\".retweets\", \"node => node.innerText\"));" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "tweet_handle = await page.query_selector(\".tweet\")", + "assert await tweet_handle.eval_on_selector(\".like\", \"node => node.innerText\") == \"100\"", + "assert await tweet_handle.eval_on_selector(\".retweets\", \"node => node.innerText\") = \"10\"" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "tweet_handle = page.query_selector(\".tweet\")", + "assert tweet_handle.eval_on_selector(\".like\", \"node => node.innerText\") == \"100\"", + "assert tweet_handle.eval_on_selector(\".retweets\", \"node => node.innerText\") = \"10\"" + ], + "codeLang": "python sync" + }, + { + "type": "code", + "lines": [ + "var tweetHandle = await page.QuerySelectorAsync(\".tweet\");", + "Assert.AreEqual(\"100\", await tweetHandle.EvalOnSelectorAsync(\".like\", \"node => node.innerText\"));", + "Assert.AreEqual(\"10\", await tweetHandle.EvalOnSelectorAsync(\".retweets\", \"node => node.innerText\"));" + ], + "codeLang": "csharp" + } + ], + "required": true, + "comment": "Returns the return value of `expression`.\n\nThe method finds an element matching the specified selector in the `ElementHandle`s subtree and passes it as a\nfirst argument to `expression`. If no elements match the selector, the method throws an error.\n\nIf `expression` returns a [Promise], then [`method: ElementHandle.evalOnSelector`] would wait for the promise to\nresolve and return its value.\n\n**Usage**\n\n```js\nconst tweetHandle = await page.$('.tweet');\nexpect(await tweetHandle.$eval('.like', node => node.innerText)).toBe('100');\nexpect(await tweetHandle.$eval('.retweets', node => node.innerText)).toBe('10');\n```\n\n```java\nElementHandle tweetHandle = page.querySelector(\".tweet\");\nassertEquals(\"100\", tweetHandle.evalOnSelector(\".like\", \"node => node.innerText\"));\nassertEquals(\"10\", tweetHandle.evalOnSelector(\".retweets\", \"node => node.innerText\"));\n```\n\n```py\ntweet_handle = await page.query_selector(\".tweet\")\nassert await tweet_handle.eval_on_selector(\".like\", \"node => node.innerText\") == \"100\"\nassert await tweet_handle.eval_on_selector(\".retweets\", \"node => node.innerText\") = \"10\"\n```\n\n```py\ntweet_handle = page.query_selector(\".tweet\")\nassert tweet_handle.eval_on_selector(\".like\", \"node => node.innerText\") == \"100\"\nassert tweet_handle.eval_on_selector(\".retweets\", \"node => node.innerText\") = \"10\"\n```\n\n```csharp\nvar tweetHandle = await page.QuerySelectorAsync(\".tweet\");\nAssert.AreEqual(\"100\", await tweetHandle.EvalOnSelectorAsync(\".like\", \"node => node.innerText\"));\nAssert.AreEqual(\"10\", await tweetHandle.EvalOnSelectorAsync(\".retweets\", \"node => node.innerText\"));\n```\n", + "async": true, + "alias": "evalOnSelector", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.9", + "name": "selector", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "A selector to query for." + } + ], + "required": true, + "comment": "A selector to query for.", + "async": false, + "alias": "selector", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "overrides": { + "js": { "kind": "property", "langs": { "only": [ @@ -26725,407 +36077,428 @@ "overrides": {} }, "experimental": false, - "since": "v1.8", - "name": "recordVideo", + "since": "v1.9", + "name": "expression", "type": { - "name": "Object", - "properties": [ + "name": "", + "union": [ { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "dir", - "type": { - "name": "path", - "expression": "[path]" - }, - "spec": [ + "name": "function", + "args": [ { - "type": "text", - "text": "Path to the directory to put videos into." + "name": "Element" } - ], - "required": true, - "comment": "Path to the directory to put videos into.", - "deprecated": false, - "async": false, - "alias": "dir", - "overloadIndex": 0, - "paramOrOption": null + ] }, { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "size", - "type": { - "name": "Object", - "properties": [ - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "width", - "type": { - "name": "int", - "expression": "[int]" - }, - "spec": [ - { - "type": "text", - "text": "Video frame width." - } - ], - "required": true, - "comment": "Video frame width.", - "deprecated": false, - "async": false, - "alias": "width", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "height", - "type": { - "name": "int", - "expression": "[int]" - }, - "spec": [ - { - "type": "text", - "text": "Video frame height." - } - ], - "required": true, - "comment": "Video frame height.", - "deprecated": false, - "async": false, - "alias": "height", - "overloadIndex": 0, - "paramOrOption": null - } - ], - "expression": "[Object]" - }, - "spec": [ - { - "type": "text", - "text": "Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size." - } - ], - "required": false, - "comment": "Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit\ninto 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page\nwill be scaled down if necessary to fit the specified size.", - "deprecated": false, - "async": false, - "alias": "size", - "overloadIndex": 0, - "paramOrOption": null + "name": "string" } ], - "expression": "[Object]" - }, - "spec": [ - { - "type": "text", - "text": "Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make sure to await [`method: BrowserContext.close`] for videos to be saved." - } - ], - "required": false, - "comment": "Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make\nsure to await [`method: BrowserContext.close`] for videos to be saved.", - "deprecated": false, - "async": false, - "alias": "recordVideo", - "overloadIndex": 0, - "paramOrOption": null - }, - { - "kind": "property", - "langs": { - "only": [ - "csharp", - "java", - "python" - ], - "aliases": { - "python": "record_video_dir" - }, - "types": {}, - "overrides": {} - }, - "experimental": false, - "since": "v1.8", - "name": "recordVideoDir", - "type": { - "name": "path", - "expression": "[path]" + "expression": "[function]([Element])|[string]" }, "spec": [ { "type": "text", - "text": "Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make sure to call [`method: BrowserContext.close`] for videos to be saved." + "text": "Function to be evaluated in the page context." } ], - "required": false, - "comment": "Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make sure\nto call [`method: BrowserContext.close`] for videos to be saved.", - "deprecated": false, + "argsArray": [], + "required": true, + "comment": "", + "args": {}, + "clazz": null, "async": false, - "alias": "recordVideoDir", + "alias": "pageFunction", "overloadIndex": 0, "paramOrOption": null - }, - { + } + } + }, + "experimental": false, + "since": "v1.9", + "name": "expression", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "JavaScript expression to be evaluated in the browser context. If the expression evaluates↵to a function, the function is automatically invoked." + } + ], + "required": true, + "comment": "JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the\nfunction is automatically invoked.", + "async": false, + "alias": "expression", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.9", + "name": "arg", + "type": { + "name": "EvaluationArgument", + "expression": "[EvaluationArgument]" + }, + "spec": [ + { + "type": "text", + "text": "Optional argument to pass to `expression`." + } + ], + "required": false, + "comment": "Optional argument to pass to `expression`.", + "async": false, + "alias": "arg", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": { + "aliases": { + "python": "eval_on_selector_all", + "js": "$$eval" + }, + "types": {}, + "overrides": {} + }, + "experimental": false, + "since": "v1.9", + "name": "evalOnSelectorAll", + "type": { + "name": "Serializable", + "expression": "[Serializable]" + }, + "spec": [ + { + "type": "text", + "text": "Returns the return value of `expression`." + }, + { + "type": "text", + "text": "The method finds all elements matching the specified selector in the `ElementHandle`'s subtree and passes an array of↵matched elements as a first argument to `expression`." + }, + { + "type": "text", + "text": "If `expression` returns a [Promise], then [`method: ElementHandle.evalOnSelectorAll`] would wait for the promise to resolve and return its↵value." + }, + { + "type": "text", + "text": "**Usage**" + }, + { + "type": "code", + "lines": [ + "
", + "
Hello!
", + "
Hi!
", + "
" + ], + "codeLang": "html" + }, + { + "type": "code", + "lines": [ + "const feedHandle = await page.$('.feed');", + "expect(await feedHandle.$$eval('.tweet', nodes => nodes.map(n => n.innerText))).toEqual(['Hello!', 'Hi!']);" + ], + "codeLang": "js" + }, + { + "type": "code", + "lines": [ + "ElementHandle feedHandle = page.querySelector(\".feed\");", + "assertEquals(Arrays.asList(\"Hello!\", \"Hi!\"), feedHandle.evalOnSelectorAll(\".tweet\", \"nodes => nodes.map(n => n.innerText)\"));" + ], + "codeLang": "java" + }, + { + "type": "code", + "lines": [ + "feed_handle = await page.query_selector(\".feed\")", + "assert await feed_handle.eval_on_selector_all(\".tweet\", \"nodes => nodes.map(n => n.innerText)\") == [\"hello!\", \"hi!\"]" + ], + "codeLang": "python async" + }, + { + "type": "code", + "lines": [ + "feed_handle = page.query_selector(\".feed\")", + "assert feed_handle.eval_on_selector_all(\".tweet\", \"nodes => nodes.map(n => n.innerText)\") == [\"hello!\", \"hi!\"]" + ], + "codeLang": "python sync" + }, + { + "type": "code", + "lines": [ + "var feedHandle = await page.QuerySelectorAsync(\".feed\");", + "Assert.AreEqual(new [] { \"Hello!\", \"Hi!\" }, await feedHandle.EvalOnSelectorAllAsync(\".tweet\", \"nodes => nodes.map(n => n.innerText)\"));" + ], + "codeLang": "csharp" + } + ], + "required": true, + "comment": "Returns the return value of `expression`.\n\nThe method finds all elements matching the specified selector in the `ElementHandle`'s subtree and passes an array\nof matched elements as a first argument to `expression`.\n\nIf `expression` returns a [Promise], then [`method: ElementHandle.evalOnSelectorAll`] would wait for the promise to\nresolve and return its value.\n\n**Usage**\n\n```html\n
\n
Hello!
\n
Hi!
\n
\n```\n\n```js\nconst feedHandle = await page.$('.feed');\nexpect(await feedHandle.$$eval('.tweet', nodes => nodes.map(n => n.innerText))).toEqual(['Hello!', 'Hi!']);\n```\n\n```java\nElementHandle feedHandle = page.querySelector(\".feed\");\nassertEquals(Arrays.asList(\"Hello!\", \"Hi!\"), feedHandle.evalOnSelectorAll(\".tweet\", \"nodes => nodes.map(n => n.innerText)\"));\n```\n\n```py\nfeed_handle = await page.query_selector(\".feed\")\nassert await feed_handle.eval_on_selector_all(\".tweet\", \"nodes => nodes.map(n => n.innerText)\") == [\"hello!\", \"hi!\"]\n```\n\n```py\nfeed_handle = page.query_selector(\".feed\")\nassert feed_handle.eval_on_selector_all(\".tweet\", \"nodes => nodes.map(n => n.innerText)\") == [\"hello!\", \"hi!\"]\n```\n\n```csharp\nvar feedHandle = await page.QuerySelectorAsync(\".feed\");\nAssert.AreEqual(new [] { \"Hello!\", \"Hi!\" }, await feedHandle.EvalOnSelectorAllAsync(\".tweet\", \"nodes => nodes.map(n => n.innerText)\"));\n```\n", + "async": true, + "alias": "evalOnSelectorAll", + "overloadIndex": 0, + "paramOrOption": null, + "args": [ + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.9", + "name": "selector", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "A selector to query for." + } + ], + "required": true, + "comment": "A selector to query for.", + "async": false, + "alias": "selector", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": { + "overrides": { + "js": { "kind": "property", "langs": { "only": [ - "csharp", - "java", - "python" - ], - "aliases": { - "python": "record_video_size" - }, + "js" + ], + "aliases": {}, "types": {}, "overrides": {} }, "experimental": false, - "since": "v1.8", - "name": "recordVideoSize", + "since": "v1.9", + "name": "expression", "type": { - "name": "Object", - "properties": [ + "name": "", + "union": [ { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "width", - "type": { - "name": "int", - "expression": "[int]" - }, - "spec": [ + "name": "function", + "args": [ { - "type": "text", - "text": "Video frame width." + "name": "Array", + "templates": [ + { + "name": "Element" + } + ] } - ], - "required": true, - "comment": "Video frame width.", - "deprecated": false, - "async": false, - "alias": "width", - "overloadIndex": 0, - "paramOrOption": null + ] }, { - "kind": "property", - "langs": {}, - "experimental": false, - "since": "v1.0", - "name": "height", - "type": { - "name": "int", - "expression": "[int]" - }, - "spec": [ - { - "type": "text", - "text": "Video frame height." - } - ], - "required": true, - "comment": "Video frame height.", - "deprecated": false, - "async": false, - "alias": "height", - "overloadIndex": 0, - "paramOrOption": null + "name": "string" } ], - "expression": "[Object]" + "expression": "[function]([Array]<[Element]>)|[string]" }, "spec": [ { "type": "text", - "text": "Dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size." + "text": "Function to be evaluated in the page context." } ], - "required": false, - "comment": "Dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit into\n800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page will\nbe scaled down if necessary to fit the specified size.", - "deprecated": false, + "argsArray": [], + "required": true, + "comment": "", + "args": {}, + "clazz": null, "async": false, - "alias": "recordVideoSize", + "alias": "pageFunction", "overloadIndex": 0, "paramOrOption": null - }, + } + } + }, + "experimental": false, + "since": "v1.9", + "name": "expression", + "type": { + "name": "string", + "expression": "[string]" + }, + "spec": [ + { + "type": "text", + "text": "JavaScript expression to be evaluated in the browser context. If the expression evaluates↵to a function, the function is automatically invoked." + } + ], + "required": true, + "comment": "JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the\nfunction is automatically invoked.", + "async": false, + "alias": "expression", + "overloadIndex": 0, + "paramOrOption": null + }, + { + "kind": "property", + "langs": {}, + "experimental": false, + "since": "v1.9", + "name": "arg", + "type": { + "name": "EvaluationArgument", + "expression": "[EvaluationArgument]" + }, + "spec": [ + { + "type": "text", + "text": "Optional argument to pass to `expression`." + } + ], + "required": false, + "comment": "Optional argument to pass to `expression`.", + "async": false, + "alias": "arg", + "overloadIndex": 0, + "paramOrOption": null + } + ] + }, + { + "kind": "method", + "langs": {}, + "experimental": false, + "since": "v1.8", + "name": "fill", + "type": { + "name": "void" + }, + "spec": [ + { + "type": "text", + "text": "This method waits for [actionability](../actionability.md) checks, focuses the element, fills it and triggers an `input` event after filling. Note that you can pass an empty string to clear the input field." + }, + { + "type": "text", + "text": "If the target element is not an ``, `