mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
33 lines
1.1 KiB
Markdown
33 lines
1.1 KiB
Markdown
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
|
|
||
|
|
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [createPDFStream](./puppeteer.page.createpdfstream.md)
|
||
|
|
|
||
|
|
## Page.createPDFStream() method
|
||
|
|
|
||
|
|
Generatees a PDF of the page with the `print` CSS media type.
|
||
|
|
|
||
|
|
<b>Signature:</b>
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
createPDFStream(options?: PDFOptions): Promise<Readable>;
|
||
|
|
```
|
||
|
|
|
||
|
|
## Parameters
|
||
|
|
|
||
|
|
| Parameter | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| options | [PDFOptions](./puppeteer.pdfoptions.md) | options for generating the PDF. |
|
||
|
|
|
||
|
|
<b>Returns:</b>
|
||
|
|
|
||
|
|
Promise<Readable>
|
||
|
|
|
||
|
|
## Remarks
|
||
|
|
|
||
|
|
NOTE: 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.
|
||
|
|
|