chore: mention default value of timeout for page.pdf() and how to…

… disable it This was mentioned in the PR that adding this feature puppeteer#7508 But it has lost at puppeteer#8593. I'm not sure why this was removed, but I think this info is useful for users.
y-yagi · Oct 24, 2022 · 0d4054e · 0d4054e
1 parent 4bf338b
commit 0d4054e
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/api/puppeteer.pdfoptions.md b/docs/api/puppeteer.pdfoptions.md
@@ -29,5 +29,5 @@ export interface PDFOptions
 | [preferCSSPageSize?](./puppeteer.pdfoptions.prefercsspagesize.md)     |           | boolean                                   | <i>(Optional)</i> Give any CSS <code>@page</code> size declared in the page priority over what is declared in the <code>width</code> or <code>height</code> or <code>format</code> option.                                                                                                                                                                                                        |
 | [printBackground?](./puppeteer.pdfoptions.printbackground.md)         |           | boolean                                   | <i>(Optional)</i> Set to <code>true</code> to print background graphics.                                                                                                                                                                                                                                                                                                                          |
 | [scale?](./puppeteer.pdfoptions.scale.md)                             |           | number                                    | <i>(Optional)</i> Scales the rendering of the web page. Amount must be between <code>0.1</code> and <code>2</code>.                                                                                                                                                                                                                                                                               |
-| [timeout?](./puppeteer.pdfoptions.timeout.md)                         |           | number                                    | <i>(Optional)</i> Timeout in milliseconds                                                                                                                                                                                                                                                                                                                                                         |
+| [timeout?](./puppeteer.pdfoptions.timeout.md)                         |           | number                                    | <i>(Optional)</i> Timeout in milliseconds, defaults to 30 seconds, pass 0 to disable timeout.                                                                                                                                                                                                                                                                                                                                                         |
 | [width?](./puppeteer.pdfoptions.width.md)                             |           | string \| number                          | <i>(Optional)</i> Sets the width of paper. You can pass in a number or a string with a unit.                                                                                                                                                                                                                                                                                                      |
diff --git a/docs/api/puppeteer.pdfoptions.timeout.md b/docs/api/puppeteer.pdfoptions.timeout.md
@@ -4,7 +4,7 @@ sidebar_label: PDFOptions.timeout
 
 # PDFOptions.timeout property
 
-Timeout in milliseconds
+Timeout in milliseconds, defaults to 30 seconds, pass 0 to disable timeout.
 
 **Signature:**