Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 1 commit into from Dec 12, 2022
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/puppeteer.pdfoptions.md
View file
Open in desktop
Expand Up @@ -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. | |
2 changes: 1 addition & 1 deletion docs/api/puppeteer.pdfoptions.timeout.md
View file
Open in desktop
Expand Up @@ -4,7 +4,7 @@ sidebar_label: PDFOptions.timeout

# PDFOptions.timeout property

Timeout in milliseconds
Timeout in milliseconds. Pass `0` to disable timeout.

#### Signature:

Expand Down
2 changes: 1 addition & 1 deletion packages/puppeteer-core/src/common/PDFOptions.ts
View file
Open in desktop
Expand Up @@ -167,7 +167,7 @@ export interface PDFOptions {
*/
omitBackground?: boolean;
/**
* Timeout in milliseconds
* Timeout in milliseconds. Pass `0` to disable timeout.
* @defaultValue 30000
*/
timeout?: number;
Expand Down