From 3c51f7d9927bbfc81d88bd75a4cb6b6bba5d5515 Mon Sep 17 00:00:00 2001 From: Yury Semikhatsky Date: Wed, 22 Sep 2021 11:03:39 -0700 Subject: [PATCH] docs: improve ignorehttpserrors description (#9081) --- 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 0a7dfbf708..4a649c538e 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 5f3dcd2bee..8375c4f8e3 100644 --- a/types/test.d.ts +++ b/types/test.d.ts @@ -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; /** diff --git a/types/types.d.ts b/types/types.d.ts index 2ec4db13c0..dc2fe06a80 100644 --- a/types/types.d.ts +++ b/types/types.d.ts @@ -9739,7 +9739,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; }; @@ -9813,7 +9813,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; @@ -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;