diff --git a/docs/api/puppeteer.pdfoptions.md b/docs/api/puppeteer.pdfoptions.md index a1af79d0e64..f517c2244ab 100644 --- 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 | (Optional) Give any CSS @page size declared in the page priority over what is declared in the width or height or format option. | false, which will scale the content to fit the paper size. | | [printBackground?](./puppeteer.pdfoptions.printbackground.md) | | boolean | (Optional) Set to true to print background graphics. | false | | [scale?](./puppeteer.pdfoptions.scale.md) | | number | (Optional) Scales the rendering of the web page. Amount must be between 0.1 and 2. | 1 | -| [timeout?](./puppeteer.pdfoptions.timeout.md) | | number | (Optional) Timeout in milliseconds | 30000 | +| [timeout?](./puppeteer.pdfoptions.timeout.md) | | number | (Optional) Timeout in milliseconds. Pass 0 to disable timeout. | 30000 | | [width?](./puppeteer.pdfoptions.width.md) | | string \| number | (Optional) 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 index a124a55f3d3..2259dd08bf0 100644 --- 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 index 2613b4273fe..c11c6c6814f 100644 --- 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;