From cee394d6e02dceca9d71c79e7c4c3daa9a93097d Mon Sep 17 00:00:00 2001 From: Yury Semikhatsky Date: Tue, 2 Feb 2021 10:46:36 -0800 Subject: [PATCH] docs: split ignoreDefaultArgs into 2 options for java (#5251) --- docs/src/api/class-browsertype.md | 18 +++--------------- docs/src/api/java.md | 7 ++++++- docs/src/api/params.md | 21 +++++++++++++++++++++ types/types.d.ts | 8 ++++---- 4 files changed, 34 insertions(+), 20 deletions(-) diff --git a/docs/src/api/class-browsertype.md b/docs/src/api/class-browsertype.md index b782aa17db62c..b73f7f1817f4c 100644 --- a/docs/src/api/class-browsertype.md +++ b/docs/src/api/class-browsertype.md @@ -129,11 +129,7 @@ Firefox or WebKit, use at your own risk. 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/). -### option: BrowserType.launch.ignoreDefaultArgs -- `ignoreDefaultArgs` <[boolean]|[Array]<[string]>> - -If `true`, Playwright does not pass its own configurations args and only uses the ones from [`option: args`]. If an -array is given, then filters out the given default arguments. Dangerous option; use with care. Defaults to `false`. +### option: BrowserType.launch.ignoreDefaultArgs = %%-browser-option-ignoredefaultargs-%% ### option: BrowserType.launch.proxy = %%-browser-option-proxy-%% @@ -240,11 +236,7 @@ bundled Chromium, Firefox or WebKit, use at your own risk. 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/). -### option: BrowserType.launchPersistentContext.ignoreDefaultArgs -- `ignoreDefaultArgs` <[boolean]|[Array]<[string]>> - -If `true`, then do not use any of the default arguments. If an array is given, then filter out the given default -arguments. Dangerous option; use with care. Defaults to `false`. +### option: BrowserType.launchPersistentContext.ignoreDefaultArgs = %%-browser-option-ignoredefaultargs-%% ### option: BrowserType.launchPersistentContext.proxy = %%-browser-option-proxy-%% @@ -347,11 +339,7 @@ bundled Chromium, Firefox or WebKit, use at your own risk. 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/). -### option: BrowserType.launchServer.ignoreDefaultArgs -- `ignoreDefaultArgs` <[boolean]|[Array]<[string]>> - -If `true`, then do not use any of the default arguments. If an array is given, then filter out the given default -arguments. Dangerous option; use with care. Defaults to `false`. +### option: BrowserType.launchServer.ignoreDefaultArgs = %%-browser-option-ignoredefaultargs-%% ### option: BrowserType.launchServer.proxy = %%-browser-option-proxy-%% diff --git a/docs/src/api/java.md b/docs/src/api/java.md index 4701648b49bfc..06337cea1e316 100644 --- a/docs/src/api/java.md +++ b/docs/src/api/java.md @@ -1,4 +1,9 @@ ## method: Playwright.close * langs: java -Terminates this instance of Playwright, will also close all created browsers if they are still running. \ No newline at end of file +Terminates this instance of Playwright, will also close all created browsers if they are still running. + +### option: BrowserType.launch.ignoreDefaultArgs = %%-csharp-java-browser-option-ignoredefaultargs-%% +### option: BrowserType.launchPersistentContext.ignoreDefaultArgs = %%-csharp-java-browser-option-ignoredefaultargs-%% +### option: BrowserType.launch.ignoreAllDefaultArgs = %%-csharp-java-browser-option-ignorealldefaultargs-%% +### option: BrowserType.launchPersistentContext.ignoreAllDefaultArgs = %%-csharp-java-browser-option-ignorealldefaultargs-%% diff --git a/docs/src/api/params.md b/docs/src/api/params.md index cddc8b032ce9e..522b8e085807f 100644 --- a/docs/src/api/params.md +++ b/docs/src/api/params.md @@ -98,6 +98,27 @@ Defaults to `'visible'`. Can be either: * `'hidden'` - wait for element to be either detached from DOM, or have an empty bounding box or `visibility:hidden`. This is opposite to the `'visible'` option. +## browser-option-ignoredefaultargs +* langs: js, python +- `ignoreDefaultArgs` <[boolean]|[Array]<[string]>> + +If `true`, Playwright does not pass its own configurations args and only uses the ones from [`option: args`]. If an +array is given, then filters out the given default arguments. Dangerous option; use with care. Defaults to `false`. + +## csharp-java-browser-option-ignoredefaultargs +* langs: csharp, java +- `ignoreDefaultArgs` <[Array]<[string]>> + +If `true`, Playwright does not pass its own configurations args and only uses the ones from [`option: args`]. +Dangerous option; use with care. + +## csharp-java-browser-option-ignorealldefaultargs +* langs: csharp, java +- `ignoreAllDefaultArgs` <[boolean]> + +If `true`, Playwright does not pass its own configurations args and only uses the ones from [`option: args`]. +Dangerous option; use with care. Defaults to `false`. + ## browser-option-proxy - `proxy` <[Object]> - `server` <[string]> Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example diff --git a/types/types.d.ts b/types/types.d.ts index b2f1bca226a4f..0f0b5806bce31 100644 --- a/types/types.d.ts +++ b/types/types.d.ts @@ -6378,8 +6378,8 @@ export interface BrowserType { }; /** - * If `true`, then do not use any of the default arguments. If an array is given, then filter out the given default - * arguments. Dangerous option; use with care. Defaults to `false`. + * 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`. */ ignoreDefaultArgs?: boolean|Array; @@ -6644,8 +6644,8 @@ export interface BrowserType { headless?: boolean; /** - * If `true`, then do not use any of the default arguments. If an array is given, then filter out the given default - * arguments. Dangerous option; use with care. Defaults to `false`. + * 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`. */ ignoreDefaultArgs?: boolean|Array;