cherry-pick(1.15): docs: improve ignorehttpserrors description (#9081) (#9111)

This commit is contained in:
Yury Semikhatsky 2021-09-23 11:14:01 -07:00 committed by GitHub
parent bb4cf28879
commit c691347fd4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 14 additions and 14 deletions

View file

@ -248,7 +248,7 @@ Whether to automatically download all the attachments. Defaults to `false` where
## context-option-ignorehttpserrors
- `ignoreHTTPSErrors` <[boolean]>
Whether to ignore HTTPS errors during navigation. Defaults to `false`.
Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.
## context-option-bypasscsp
- `bypassCSP` <[boolean]>
@ -395,7 +395,7 @@ A list of permissions to grant to all pages in this context. See
## context-option-extrahttpheaders
- `extraHTTPHeaders` <[Object]<[string], [string]>>
An object containing additional HTTP headers to be sent with every request. All header values must be strings.
An object containing additional HTTP headers to be sent with every request.
## context-option-offline
- `offline` <[boolean]>

4
types/test.d.ts vendored
View file

@ -2498,7 +2498,7 @@ export interface PlaywrightTestOptions {
*/
deviceScaleFactor: number | undefined;
/**
* An object containing additional HTTP headers to be sent with every request. All header values must be strings.
* An object containing additional HTTP headers to be sent with every request.
*/
extraHTTPHeaders: ExtraHTTPHeaders | undefined;
geolocation: Geolocation | undefined;
@ -2511,7 +2511,7 @@ export interface PlaywrightTestOptions {
*/
httpCredentials: HTTPCredentials | undefined;
/**
* Whether to ignore HTTPS errors during navigation. Defaults to `false`.
* Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.
*/
ignoreHTTPSErrors: boolean | undefined;
/**

20
types/types.d.ts vendored
View file

@ -9733,7 +9733,7 @@ export interface BrowserType<Unused = {}> {
executablePath?: string;
/**
* An object containing additional HTTP headers to be sent with every request. All header values must be strings.
* An object containing additional HTTP headers to be sent with every request.
*/
extraHTTPHeaders?: { [key: string]: string; };
@ -9807,7 +9807,7 @@ export interface BrowserType<Unused = {}> {
ignoreDefaultArgs?: boolean|Array<string>;
/**
* Whether to ignore HTTPS errors during navigation. Defaults to `false`.
* Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.
*/
ignoreHTTPSErrors?: boolean;
@ -10928,7 +10928,7 @@ export interface AndroidDevice {
deviceScaleFactor?: number;
/**
* An object containing additional HTTP headers to be sent with every request. All header values must be strings.
* An object containing additional HTTP headers to be sent with every request.
*/
extraHTTPHeaders?: { [key: string]: string; };
@ -10973,7 +10973,7 @@ export interface AndroidDevice {
};
/**
* Whether to ignore HTTPS errors during navigation. Defaults to `false`.
* Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.
*/
ignoreHTTPSErrors?: boolean;
@ -11704,7 +11704,7 @@ export interface Browser extends EventEmitter {
deviceScaleFactor?: number;
/**
* An object containing additional HTTP headers to be sent with every request. All header values must be strings.
* An object containing additional HTTP headers to be sent with every request.
*/
extraHTTPHeaders?: { [key: string]: string; };
@ -11749,7 +11749,7 @@ export interface Browser extends EventEmitter {
};
/**
* Whether to ignore HTTPS errors during navigation. Defaults to `false`.
* Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.
*/
ignoreHTTPSErrors?: boolean;
@ -12510,7 +12510,7 @@ export interface Electron {
executablePath?: string;
/**
* An object containing additional HTTP headers to be sent with every request. All header values must be strings.
* An object containing additional HTTP headers to be sent with every request.
*/
extraHTTPHeaders?: { [key: string]: string; };
@ -12541,7 +12541,7 @@ export interface Electron {
};
/**
* Whether to ignore HTTPS errors during navigation. Defaults to `false`.
* Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.
*/
ignoreHTTPSErrors?: boolean;
@ -14210,7 +14210,7 @@ export interface BrowserContextOptions {
deviceScaleFactor?: number;
/**
* An object containing additional HTTP headers to be sent with every request. All header values must be strings.
* An object containing additional HTTP headers to be sent with every request.
*/
extraHTTPHeaders?: { [key: string]: string; };
@ -14236,7 +14236,7 @@ export interface BrowserContextOptions {
httpCredentials?: HTTPCredentials;
/**
* Whether to ignore HTTPS errors during navigation. Defaults to `false`.
* Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.
*/
ignoreHTTPSErrors?: boolean;