docs: mention how to disable timeout for page.pdf() (#9167)

**What kind of change does this PR introduce?** Add how to disable timeout for `page.pdf()`. **Summary** This was mentioned in the PR that adding this feature #7508 But it has lost at #8593. I'm not sure why this was removed, but I think this info is useful for users. **Does this PR introduce a breaking change?** no
puppeteer · Dec 12, 2022 · a304543 · a304543
1 parent d55af2d
commit a304543
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 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.                                                                                                                                                                                                        | <code>false</code>, which will scale the content to fit the paper size. |
 | [printBackground?](./puppeteer.pdfoptions.printbackground.md)         |           | boolean                                   | <i>(Optional)</i> Set to <code>true</code> to print background graphics.                                                                                                                                                                                                                                                                                                                          | false                                                                   |
 | [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>.                                                                                                                                                                                                                                                                               | 1                                                                       |
-| [timeout?](./puppeteer.pdfoptions.timeout.md)                         |           | number                                    | <i>(Optional)</i> Timeout in milliseconds                                                                                                                                                                                                                                                                                                                                                         | 30000                                                                   |
+| [timeout?](./puppeteer.pdfoptions.timeout.md)                         |           | number                                    | <i>(Optional)</i> Timeout in milliseconds. Pass <code>0</code> to disable timeout.                                                                                                                                                                                                                                                                                                                | 30000                                                                   |
 | [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. Pass `0` to disable timeout.
 
 #### Signature:
 

diff --git a/packages/puppeteer-core/src/common/PDFOptions.ts b/packages/puppeteer-core/src/common/PDFOptions.ts
@@ -167,7 +167,7 @@ export interface PDFOptions {
    */
   omitBackground?: boolean;
   /**
-   * Timeout in milliseconds
+   * Timeout in milliseconds. Pass `0` to disable timeout.
    * @defaultValue 30000
    */
   timeout?: number;