puppeteer/docs/api/puppeteer.page.createpdfstream.md
jrandolf f07ad2c661
fix: update documentation on configuring puppeteer ()
This PR updates the docs regarding configuring puppeteer. In addition,
some changes have been made to the documentation generator to show
default values on the documentation site.

Also fixes: https://github.com/puppeteer/puppeteer/pull/9144
2022-10-24 09:07:05 +02:00

1.1 KiB

sidebar_label
Page.createPDFStream

Page.createPDFStream() method

Generates a PDF of the page with the print CSS media type.

Signature:

class Page {
  createPDFStream(options?: PDFOptions): Promise<Readable>;
}

Parameters

Parameter Type Description
options PDFOptions (Optional) options for generating the PDF.

Returns:

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')` before calling page.pdf().

By default, page.pdf() generates a pdf with modified colors for printing. Use the `-webkit-print-color-adjust` property to force rendering of exact colors.