Type Alias BrowserRunPDFOptions

Type Declaration

• OptionalpdfOptions?: {
      displayHeaderFooter?: boolean;
      footerTemplate?: string;
      format?:
          | "letter"
          | "legal"
          | "tabloid"
          | "ledger"
          | "a0"
          | "a1"
          | "a2"
          | "a3"
          | "a4"
          | "a5"
          | "a6";
      headerTemplate?: string;
      height?: string
      | number;
      landscape?: boolean;
      margin?: {
          bottom?: string | number;
          left?: string | number;
          right?: string | number;
          top?: string | number;
      };
      omitBackground?: boolean;
      outline?: boolean;
      pageRanges?: string;
      preferCSSPageSize?: boolean;
      printBackground?: boolean;
      scale?: number;
      tagged?: boolean;
      timeout?: number;
      width?: string
      | number;
  }

  See

  https://pptr.dev/api/puppeteer.pdfoptions

  • OptionaldisplayHeaderFooter?: boolean

    Default

    false
    Copy

  • OptionalfooterTemplate?: string

  • Optionalformat?:
        | "letter"
        | "legal"
        | "tabloid"
        | "ledger"
        | "a0"
        | "a1"
        | "a2"
        | "a3"
        | "a4"
        | "a5"
        | "a6"

    Default

    "letter"
    Copy

  • OptionalheaderTemplate?: string

  • Optionalheight?: string | number

  • Optionallandscape?: boolean

    Default

    false
    Copy

  • Optionalmargin?: {
        bottom?: string | number;
        left?: string | number;
        right?: string | number;
        top?: string | number;
    }

  • OptionalomitBackground?: boolean

    Default

    false
    Copy

  • Optionaloutline?: boolean

    Default

    false
    Copy

  • OptionalpageRanges?: string

  • OptionalpreferCSSPageSize?: boolean

    Default

    false
    Copy

  • OptionalprintBackground?: boolean

    Default

    false
    Copy

  • Optionalscale?: number

    Default

    1
    Copy

  • Optionaltagged?: boolean

    Default

    true
    Copy

  • Optionaltimeout?: number

    Default

    30000
    Copy

  • Optionalwidth?: string | number