From 61536098be5d68d6e90751805f36849185ceb6a0 Mon Sep 17 00:00:00 2001 From: Ross Wollman Date: Mon, 13 Jun 2022 15:18:24 -0700 Subject: [PATCH] docs: fix serviceWorkers formatting (#14845) --- docs/src/api/params.md | 6 ++--- packages/playwright-core/types/types.d.ts | 32 +++++++++-------------- packages/playwright-test/types/test.d.ts | 8 +++--- 3 files changed, 18 insertions(+), 28 deletions(-) diff --git a/docs/src/api/params.md b/docs/src/api/params.md index 212bb00097..be84024e4f 100644 --- a/docs/src/api/params.md +++ b/docs/src/api/params.md @@ -644,10 +644,10 @@ See [Locator] to learn more about the strict mode. ## context-option-service-worker-policy - `serviceWorkers` <[ServiceWorkerPolicy]<"allow"|"block">> -* `"allow"`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be registered by sites. -* `"block"`: Playwright will block all registration of Service Workers. +Whether to allow sites to register Service workers. Defaults to `'allow'`. +* `'allow'`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be registered. +* `'block'`: Playwright will block all registration of Service Workers. -Defaults to `"allow"`. ## select-options-values * langs: java, js, csharp diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts index 93c4ab91f5..3ca693f58e 100644 --- a/packages/playwright-core/types/types.d.ts +++ b/packages/playwright-core/types/types.d.ts @@ -10372,11 +10372,9 @@ export interface BrowserType { }; /** - * - `"allow"`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be registered - * by sites. - * - `"block"`: Playwright will block all registration of Service Workers. - * - * Defaults to `"allow"`. + * Whether to allow sites to register Service workers. Defaults to `'allow'`. + * - `'allow'`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be registered. + * - `'block'`: Playwright will block all registration of Service Workers. */ serviceWorkers?: "allow"|"block"; @@ -11537,11 +11535,9 @@ export interface AndroidDevice { }; /** - * - `"allow"`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be registered - * by sites. - * - `"block"`: Playwright will block all registration of Service Workers. - * - * Defaults to `"allow"`. + * Whether to allow sites to register Service workers. Defaults to `'allow'`. + * - `'allow'`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be registered. + * - `'block'`: Playwright will block all registration of Service Workers. */ serviceWorkers?: "allow"|"block"; @@ -13079,11 +13075,9 @@ export interface Browser extends EventEmitter { }; /** - * - `"allow"`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be registered - * by sites. - * - `"block"`: Playwright will block all registration of Service Workers. - * - * Defaults to `"allow"`. + * Whether to allow sites to register Service workers. Defaults to `'allow'`. + * - `'allow'`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be registered. + * - `'block'`: Playwright will block all registration of Service Workers. */ serviceWorkers?: "allow"|"block"; @@ -15599,11 +15593,9 @@ export interface BrowserContextOptions { }; /** - * - `"allow"`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be registered - * by sites. - * - `"block"`: Playwright will block all registration of Service Workers. - * - * Defaults to `"allow"`. + * Whether to allow sites to register Service workers. Defaults to `'allow'`. + * - `'allow'`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be registered. + * - `'block'`: Playwright will block all registration of Service Workers. */ serviceWorkers?: "allow"|"block"; diff --git a/packages/playwright-test/types/test.d.ts b/packages/playwright-test/types/test.d.ts index 24fdefb8f9..73fc3b53da 100644 --- a/packages/playwright-test/types/test.d.ts +++ b/packages/playwright-test/types/test.d.ts @@ -2800,11 +2800,9 @@ export interface PlaywrightTestOptions { */ navigationTimeout: number | undefined; /** - * - `"allow"`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be registered - * by sites. - * - `"block"`: Playwright will block all registration of Service Workers. - * - * Defaults to `"allow"`. + * Whether to allow sites to register Service workers. Defaults to `'allow'`. + * - `'allow'`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be registered. + * - `'block'`: Playwright will block all registration of Service Workers. */ serviceWorkers: ServiceWorkerPolicy | undefined; }