docs: improve ignorehttpserrors description (#9081)

This commit is contained in:
Yury Semikhatsky 2021-09-22 11:03:39 -07:00 committed by GitHub
parent e85a3a5a41
commit 3c51f7d992
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

@ -2466,7 +2466,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;
@ -2479,7 +2479,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

@ -9739,7 +9739,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; };
@ -9813,7 +9813,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;
@ -10934,7 +10934,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; };
@ -10979,7 +10979,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;
@ -11710,7 +11710,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; };
@ -11755,7 +11755,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;
@ -12516,7 +12516,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; };
@ -12547,7 +12547,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;
@ -14216,7 +14216,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; };
@ -14242,7 +14242,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;