thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
**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
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.

**Does this PR introduce a breaking change?**

no
This commit is contained in:
y-yagi 2022-12-12 21:12:18 +09:00 committed by GitHub
parent d55af2df4f
commit a3045435a2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/puppeteer.pdfoptions.md
View File

@ -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. | | [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 | | [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 | | [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. | | | [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. | |

2
docs/api/puppeteer.pdfoptions.timeout.md
View File

@ -4,7 +4,7 @@ sidebar_label: PDFOptions.timeout
# PDFOptions.timeout property # PDFOptions.timeout property
Timeout in milliseconds Timeout in milliseconds. Pass `0` to disable timeout.
#### Signature: #### Signature:

2
packages/puppeteer-core/src/common/PDFOptions.ts
View File

@ -167,7 +167,7 @@ export interface PDFOptions {
*/ */
omitBackground?: boolean; omitBackground?: boolean;
/** /**
* Timeout in milliseconds * Timeout in milliseconds. Pass `0` to disable timeout.
* @defaultValue 30000 * @defaultValue 30000
*/ */
timeout?: number; timeout?: number;