PDFOptions | /mod.ts | puppeteer@16.2.0

interface PDFOptions

Re-export

import { type PDFOptions } from "https://deno.land/x/puppeteer@16.2.0/mod.ts";

Valid options to configure PDF generation via Page.pdf.

Properties

optional

scale: number

Scales the rendering of the web page. Amount must be between 0.1 and 2.

optional

displayHeaderFooter: boolean

Whether to show the header and footer.

optional

headerTemplate: string

HTML template for the print header. Should be valid HTML with the following classes used to inject values into them:

date formatted print date
title document title
url document location
pageNumber current page number
totalPages total pages in the document

optional

footerTemplate: string

HTML template for the print footer. Has the same constraints and support for special classes as PDFOptions.headerTemplate.

optional

printBackground: boolean

Set to true to print background graphics.

optional

landscape: boolean

Whether to print in landscape orientation.

optional

pageRanges: string

Paper ranges to print, e.g. 1-5, 8, 11-13.

optional

format: PaperFormat

optional

width: string | number

Sets the width of paper. You can pass in a number or a string with a unit.

optional

height: string | number

Sets the height of paper. You can pass in a number or a string with a unit.

optional

preferCSSPageSize: boolean

Give any CSS @page size declared in the page priority over what is declared in the width or height or format option.

optional

margin: PDFMargin

Set the PDF margins.

optional

path: string

The path to save the file to.

optional

omitBackground: boolean

Hides default white background and allows generating pdfs with transparency.

optional

timeout: number

Timeout in milliseconds