puppeteer/new-docs/puppeteer.page.pdf.md

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Page](./puppeteer.page.md) &gt; [pdf](./puppeteer.page.pdf.md)

## Page.pdf() method

Generatees a PDF of the page with the `print` CSS media type.

<b>Signature:</b>

```typescript
pdf(options?: PDFOptions): Promise<Buffer>;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  options | [PDFOptions](./puppeteer.pdfoptions.md) | options for generating the PDF. |

<b>Returns:</b>

Promise&lt;Buffer&gt;

## Remarks

IMPORTANT: PDF generation is only supported in Chrome headless mode.

To generate a PDF with the `screen` media type, call [\`page.emulateMediaType('screen')\`](./puppeteer.page.emulatemediatype.md) before calling `page.pdf()`<!-- -->.

By default, `page.pdf()` generates a pdf with modified colors for printing. Use the [\`-webkit-print-color-adjust\`](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-print-color-adjust) property to force rendering of exact colors.
chore: commit base new-docs (#5973) This adds the new docs that are generated by API Extractor via TSDoc. They are sparse because we do not yet use TSDoc in the codebase. This is the starting point and from here we can work through all the different classes and improve the documentation. 2020-06-04 14:56:45 +00:00			`<!-- Do not edit this file. It is automatically generated by API Documenter. -->`

			`[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [pdf](./puppeteer.page.pdf.md)`

			`## Page.pdf() method`

chore(docs): migrate page.pdf() docs (#6228) Also took the opportunity to pull out the PDF types into their own file to clear up `Page.ts` slightly and give the PDF code a more natural place to live. 2020-07-17 12:58:56 +00:00			Generatees a PDF of the page with the `print` CSS media type.

chore: commit base new-docs (#5973) This adds the new docs that are generated by API Extractor via TSDoc. They are sparse because we do not yet use TSDoc in the codebase. This is the starting point and from here we can work through all the different classes and improve the documentation. 2020-06-04 14:56:45 +00:00			`<b>Signature:</b>`

			```typescript
			`pdf(options?: PDFOptions): Promise<Buffer>;`
			```

			`## Parameters`

			`\| Parameter \| Type \| Description \|`
			`\| --- \| --- \| --- \|`
chore(docs): migrate page.pdf() docs (#6228) Also took the opportunity to pull out the PDF types into their own file to clear up `Page.ts` slightly and give the PDF code a more natural place to live. 2020-07-17 12:58:56 +00:00			`\| options \| [PDFOptions](./puppeteer.pdfoptions.md) \| options for generating the PDF. \|`
chore: commit base new-docs (#5973) This adds the new docs that are generated by API Extractor via TSDoc. They are sparse because we do not yet use TSDoc in the codebase. This is the starting point and from here we can work through all the different classes and improve the documentation. 2020-06-04 14:56:45 +00:00
			`<b>Returns:</b>`

			`Promise<Buffer>`

chore(docs): migrate page.pdf() docs (#6228) Also took the opportunity to pull out the PDF types into their own file to clear up `Page.ts` slightly and give the PDF code a more natural place to live. 2020-07-17 12:58:56 +00:00			`## Remarks`

			`IMPORTANT: PDF generation is only supported in Chrome headless mode.`

			To generate a PDF with the `screen` media type, call [\`page.emulateMediaType('screen')\`](./puppeteer.page.emulatemediatype.md) before calling `page.pdf()`<!-- -->.

			By default, `page.pdf()` generates a pdf with modified colors for printing. Use the [\`-webkit-print-color-adjust\`](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-print-color-adjust) property to force rendering of exact colors.