From 0d4054edc4e862692227e6b8b4247a8fcde4f50f Mon Sep 17 00:00:00 2001 From: "yuuji.yaginuma" Date: Mon, 24 Oct 2022 14:49:03 +0900 Subject: [PATCH] chore: mention default value of `timeout` for `page.pdf()` and how to disable it This was mentioned in the PR that adding this feature https://github.com/puppeteer/puppeteer/pull/7508 But it has lost at https://github.com/puppeteer/puppeteer/pull/8593. I'm not sure why this was removed, but I think this info is useful for users. --- docs/api/puppeteer.pdfoptions.md | 2 +- docs/api/puppeteer.pdfoptions.timeout.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/puppeteer.pdfoptions.md b/docs/api/puppeteer.pdfoptions.md index 5e7efdd95202a..496b76461b6ba 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. | | [printBackground?](./puppeteer.pdfoptions.printbackground.md) | | boolean | (Optional) Set to true to print background graphics. | | [scale?](./puppeteer.pdfoptions.scale.md) | | number | (Optional) Scales the rendering of the web page. Amount must be between 0.1 and 2. | -| [timeout?](./puppeteer.pdfoptions.timeout.md) | | number | (Optional) Timeout in milliseconds | +| [timeout?](./puppeteer.pdfoptions.timeout.md) | | number | (Optional) Timeout in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. | | [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 e9b378d30e571..106fe456b9a20 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, defaults to 30 seconds, pass 0 to disable timeout. **Signature:**