docs: clarify setDefaultTimeout with 0 value (#33959)

microsoft · Dec 11, 2024 · 9e683d7 · 9e683d7
1 parent 856704a
commit 9e683d7
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/docs/src/api/class-browsercontext.md b/docs/src/api/class-browsercontext.md
@@ -1412,7 +1412,7 @@ This setting will change the default maximum time for all the methods accepting
 * since: v1.8
 - `timeout` <[float]>
 
-Maximum time in milliseconds
+Maximum time in milliseconds. Pass `0` to disable timeout.
 
 ## async method: BrowserContext.setExtraHTTPHeaders
 * since: v1.8

diff --git a/docs/src/api/class-page.md b/docs/src/api/class-page.md
@@ -3970,7 +3970,7 @@ This setting will change the default maximum time for all the methods accepting
 * since: v1.8
 - `timeout` <[float]>
 
-Maximum time in milliseconds
+Maximum time in milliseconds. Pass `0` to disable timeout.
 
 ## async method: Page.setExtraHTTPHeaders
 * since: v1.8

diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts
@@ -4294,7 +4294,7 @@ export interface Page {
    * takes priority over
    * [page.setDefaultTimeout(timeout)](https://playwright.dev/docs/api/class-page#page-set-default-timeout).
    *
-   * @param timeout Maximum time in milliseconds
+   * @param timeout Maximum time in milliseconds. Pass `0` to disable timeout.
    */
   setDefaultTimeout(timeout: number): void;
 
@@ -9193,7 +9193,7 @@ export interface BrowserContext {
    * take priority over
    * [browserContext.setDefaultTimeout(timeout)](https://playwright.dev/docs/api/class-browsercontext#browser-context-set-default-timeout).
    *
-   * @param timeout Maximum time in milliseconds
+   * @param timeout Maximum time in milliseconds. Pass `0` to disable timeout.
    */
   setDefaultTimeout(timeout: number): void;