Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Sep 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/src/api/params.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]>
Expand Down Expand Up @@ -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]>
Expand Down
4 changes: 2 additions & 2 deletions types/test.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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;
/**
Expand Down
20 changes: 10 additions & 10 deletions types/types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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; };

Expand Down Expand Up @@ -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;

Expand Down Expand Up @@ -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; };

Expand Down Expand Up @@ -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;

Expand Down Expand Up @@ -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; };

Expand Down Expand Up @@ -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;

Expand Down Expand Up @@ -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; };

Expand Down Expand Up @@ -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;

Expand Down Expand Up @@ -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; };

Expand All @@ -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;

Expand Down