From c691347fd4c07fc7b10441ef1b84a58a14c167da Mon Sep 17 00:00:00 2001 From: Yury Semikhatsky Date: Thu, 23 Sep 2021 11:14:01 -0700 Subject: [PATCH] cherry-pick(1.15): docs: improve ignorehttpserrors description (#9081) (#9111) --- docs/src/api/params.md | 4 ++-- types/test.d.ts | 4 ++-- types/types.d.ts | 20 ++++++++++---------- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/src/api/params.md b/docs/src/api/params.md index 3a1021f9cd..000d00ced8 100644 --- a/docs/src/api/params.md +++ b/docs/src/api/params.md @@ -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]> diff --git a/types/test.d.ts b/types/test.d.ts index 7ffe5c89d1..0d59df0c42 100644 --- a/types/test.d.ts +++ b/types/test.d.ts @@ -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; /** diff --git a/types/types.d.ts b/types/types.d.ts index 67a4ae6b60..510fa1677a 100644 --- a/types/types.d.ts +++ b/types/types.d.ts @@ -9733,7 +9733,7 @@ export interface BrowserType { 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 { ignoreDefaultArgs?: boolean|Array; /** - * 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;