Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@types/wkhtmltopdf

Package Overview
Dependencies
Maintainers
1
Versions
10
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@types/wkhtmltopdf - npm Package Compare versions

Comparing version 0.3.3 to 0.3.4

236

wkhtmltopdf/index.d.ts

@@ -58,49 +58,49 @@ // Type definitions for wkhtmltopdf 0.3

/** Collate when printing multiple copies (default) */
collate?: boolean;
collate?: boolean | undefined;
/** Do not collate when printing multiple copies */
noCollate?: boolean;
noCollate?: boolean | undefined;
/** Number of copies to print into the pdf file (default 1) */
copies?: number;
copies?: number | undefined;
/** Change the dpi explicitly (this has no effect on X11 based systems) (default 96) */
dpi?: number;
dpi?: number | undefined;
/** PDF will be generated in grayscale */
grayscale?: boolean;
grayscale?: boolean | undefined;
/** When embedding images scale them down to this dpi (default 600) */
imageDpi?: number;
imageDpi?: number | undefined;
/** When jpeg compressing images use this quality (default 94) */
imageQuality?: number;
imageQuality?: number | undefined;
/** Set log level (default info) */
logLevel?: "none"|"error"|"warn"|"info";
logLevel?: "none"|"error"|"warn"|"info" | undefined;
/** Generates lower quality pdf/ps. Useful to shrink the result document space */
lowquality?: boolean;
lowquality?: boolean | undefined;
/** Set the page bottom margin in unitreal (e.g 10mm 2cm 0.5in) */
marginBottom?: string;
marginBottom?: string | undefined;
/** Set the page left margin in unitreal (e.g 10mm 2cm 0.5in) (default 10mm) */
marginLeft?: string;
marginLeft?: string | undefined;
/** Set the page right margin in unitreal (e.g 10mm 2cm 0.5in) (default 10mm) */
marginRight?: string;
marginRight?: string | undefined;
/** Set the page top margin in unitreal (e.g 10mm 2cm 0.5in) */
marginTop?: string;
marginTop?: string | undefined;
/** Set orientation to Landscape or Portrait (default Portrait) */
orientation?: "Landscape"|"Portrait";
orientation?: "Landscape"|"Portrait" | undefined;
/** Page height in unitreal (e.g 10mm 2cm 0.5in) */
pageHeight?: string;
pageHeight?: string | undefined;
/** Set paper size to: A4, Letter, etc. (default A4) */
pageSize?: "A0"|"A1"|"A2"|"A3"|"A4"|"A5"|"A6"|"A7"|"A8"|"A9"|
"B0"|"B1"|"B10"|"B2"|"B3"|"B4"|"B5"|"B6"|"B7"|"B8"|"B9"|
"C5E"|"Comm10E"|"DLE"|"Executive"|"Folio"|"Ledger"|"Legal"|"Letter"|"Tabloid";
"C5E"|"Comm10E"|"DLE"|"Executive"|"Folio"|"Ledger"|"Legal"|"Letter"|"Tabloid" | undefined;
/** Page width in unitreal (e.g 10mm 2cm 0.5in) */
pageWidth?: string;
pageWidth?: string | undefined;
/** Do not use lossless compression on pdf objects */
noPdfCompression?: boolean;
noPdfCompression?: boolean | undefined;
/** Debug prints stderr messages */
debug?: boolean|((data: Buffer) => void);
debug?: boolean|((data: Buffer) => void) | undefined;
/** debugStdOut prints any stdout warning messages */
debugStdOut?: boolean;
debugStdOut?: boolean | undefined;
/** The title of the generated pdf file (The title of the first document is used if not specified) */
title?: string;
title?: string | undefined;
/** Ignore warnings */
ignore?: ReadonlyArray<string|RegExp>;
ignore?: ReadonlyArray<string|RegExp> | undefined;
/** If defined only output to this path */
output?: string;
output?: string | undefined;

@@ -111,11 +111,11 @@ /*******************

// Dump the default TOC xsl style sheet to stdout */
dumpDefaultTocXsl?: boolean;
dumpDefaultTocXsl?: boolean | undefined;
/** Dump the outline to a file */
dumpOutline?: string;
dumpOutline?: string | undefined;
/** Put an outline into the pdf (default) */
outline?: boolean;
outline?: boolean | undefined;
/** Do not put an outline into the pdf */
noOutline?: boolean;
noOutline?: boolean | undefined;
/** Set the depth of the outline (default 4) */
outlineDepth?: boolean;
outlineDepth?: boolean | undefined;

@@ -127,27 +127,27 @@ /****************

/** Allow the file or files from the specified folder to be loaded (repeatable) */
allow?: ReadonlyArray<string>;
allow?: ReadonlyArray<string> | undefined;
/** Do print background (default) */
background?: boolean;
background?: boolean | undefined;
/** Do not print background */
noBackground?: boolean;
noBackground?: boolean | undefined;
/** Bypass proxy for host (repeatable) */
bypassProxyFor?: ReadonlyArray<string>;
bypassProxyFor?: ReadonlyArray<string> | undefined;
/** Web cache directory */
cacheDir?: string;
cacheDir?: string | undefined;
/** Use this SVG file when rendering checked checkboxes */
checkboxCheckedSvg?: string;
checkboxCheckedSvg?: string | undefined;
/** Use this SVG file when rendering unchecked checkboxes */
checkboxSvg?: string;
checkboxSvg?: string | undefined;
/** Set an additional cookie (repeatable), value should be url encoded. */
cookie?: ReadonlyArray<[string, string]>;
cookie?: ReadonlyArray<[string, string]> | undefined;
/** Set an additional HTTP header (repeatable) */
customHeader?: ReadonlyArray<[string, string]>;
customHeader?: ReadonlyArray<[string, string]> | undefined;
/** Add HTTP headers specified by --custom-header for each resource request. */
customHeaderPropagation?: boolean;
customHeaderPropagation?: boolean | undefined;
/** Do not add HTTP headers specified by --custom-header for each resource request. */
noCustomHeaderPropagation?: boolean;
noCustomHeaderPropagation?: boolean | undefined;
/** Show javascript debugging output */
debugJavascript?: boolean;
debugJavascript?: boolean | undefined;
/** Do not show javascript debugging output (default) */
noDebugJavascript?: boolean;
noDebugJavascript?: boolean | undefined;
/**

@@ -159,93 +159,93 @@ * Add a default header, with the name of the page to the left, and the page number to the right, this is short for:

*/
defaultHeader?: boolean;
defaultHeader?: boolean | undefined;
/** Set the default text encoding, for input */
encoding?: string;
encoding?: string | undefined;
/** Do not make links to remote web pages */
disableExternalLinks?: boolean;
disableExternalLinks?: boolean | undefined;
/** Make links to remote web pages (default) */
enableExternalLinks?: boolean;
enableExternalLinks?: boolean | undefined;
/** Do not turn HTML form fields into pdf form fields (default) */
disableForms?: boolean;
disableForms?: boolean | undefined;
/** Turn HTML form fields into pdf form fields */
enableForms?: boolean;
enableForms?: boolean | undefined;
/** Do load or print images (default) */
images?: boolean;
images?: boolean | undefined;
/** Do not load or print images */
noImages?: boolean;
noImages?: boolean | undefined;
/** Do not make local links */
disableInternalLinks?: boolean;
disableInternalLinks?: boolean | undefined;
/** Make local links (default) */
enableInternalLinks?: boolean;
enableInternalLinks?: boolean | undefined;
/** Do not allow web pages to run javascript */
disableJavascript?: boolean;
disableJavascript?: boolean | undefined;
/** Do allow web pages to run javascript (default) */
enableJavascript?: boolean;
enableJavascript?: boolean | undefined;
/** Wait some milliseconds for javascript finish (default 200) */
javascriptDelay?: number;
javascriptDelay?: number | undefined;
/** Keep relative external links as relative external links */
keepRelativeLinks?: boolean;
keepRelativeLinks?: boolean | undefined;
/** Specify how to handle pages that fail to load: abort, ignore or skip (default abort) */
loadErrorHandling?: "abort"|"ignore"|"skip";
loadErrorHandling?: "abort"|"ignore"|"skip" | undefined;
/** Specify how to handle media files that fail to load: abort, ignore or skip (default ignore) */
loadMediaErrorHandling?: "abort"|"ignore"|"skip";
loadMediaErrorHandling?: "abort"|"ignore"|"skip" | undefined;
/** Do not allowed conversion of a local file to read in other local files, unless explicitly allowed with --allow (default) */
disableLocalFileAccess?: boolean;
disableLocalFileAccess?: boolean | undefined;
/** Allowed conversion of a local file to read in other local files. */
enableLocalFileAccess?: boolean;
enableLocalFileAccess?: boolean | undefined;
/** Minimum font size */
minimumFontSize?: number;
minimumFontSize?: number | undefined;
/** Do not include the page in the table of contents and outlines */
excludeFromOutline?: boolean;
excludeFromOutline?: boolean | undefined;
/** Include the page in the table of contents and outlines (default) */
includeInOutline?: boolean;
includeInOutline?: boolean | undefined;
/** Set the starting page number (default 0) */
pageOffset?: number;
pageOffset?: number | undefined;
/** HTTP Authentication password */
password?: string;
password?: string | undefined;
/** Disable installed plugins (default) */
disablePlugins?: boolean;
disablePlugins?: boolean | undefined;
/** Enable installed plugins (plugins will likely not work) */
enablePlugins?: boolean;
enablePlugins?: boolean | undefined;
/** Add an additional post field */
post?: ReadonlyArray<[string, string]>;
post?: ReadonlyArray<[string, string]> | undefined;
/** Post an additional file (repeatable) */
postFile?: ReadonlyArray<[string, string]>;
postFile?: ReadonlyArray<[string, string]> | undefined;
/** Use print media-type instead of screen */
printMediaType?: boolean;
printMediaType?: boolean | undefined;
/** Do not use print media-type instead of screen (default) */
noPrintMediaType?: boolean;
noPrintMediaType?: boolean | undefined;
/** Use a proxy */
proxy?: string;
proxy?: string | undefined;
/** Use the proxy for resolving hostnames */
proxyHostnameLookup?: boolean;
proxyHostnameLookup?: boolean | undefined;
/** Use this SVG file when rendering checked radiobuttons */
radiobuttonCheckedSvg?: string;
radiobuttonCheckedSvg?: string | undefined;
/** Use this SVG file when rendering unchecked radiobuttons */
radiobuttonSvg?: string;
radiobuttonSvg?: string | undefined;
/** Resolve relative external links into absolute links (default) */
resolveRelativeLinks?: boolean;
resolveRelativeLinks?: boolean | undefined;
/** Run this additional javascript after the page is done loading (repeatable) */
runScript?: ReadonlyArray<string>;
runScript?: ReadonlyArray<string> | undefined;
/** Disable the intelligent shrinking strategy used by WebKit that makes the pixel/dpi ratio non-constant */
disableSmartShrinking?: boolean;
disableSmartShrinking?: boolean | undefined;
/** Enable the intelligent shrinking strategy used by WebKit that makes the pixel/dpi ratio non-constant (default) */
enableSmartShrinking?: boolean;
enableSmartShrinking?: boolean | undefined;
/** Path to the ssl client cert public key in OpenSSL PEM format, optionally followed by intermediate ca and trusted certs */
sslCrtPath?: string;
sslCrtPath?: string | undefined;
/** Password to ssl client cert private key */
sslKeyPassword?: string;
sslKeyPassword?: string | undefined;
/** Path to ssl client cert private key in OpenSSL PEM format */
sslKeyPath?: string;
sslKeyPath?: string | undefined;
/** Stop slow running javascripts (default) */
stopSlowScripts?: boolean;
stopSlowScripts?: boolean | undefined;
/** Do not Stop slow running javascripts */
noStopSlowScripts?: boolean;
noStopSlowScripts?: boolean | undefined;
/** Do not link from section header to toc (default) */
disableTocBackLinks?: boolean;
disableTocBackLinks?: boolean | undefined;
/** Link from section header to toc */
enableTocBackLinks?: boolean;
enableTocBackLinks?: boolean | undefined;
/** Specify a user style sheet, to load with every page */
userStyleSheet?: string;
userStyleSheet?: string | undefined;
/** HTTP Authentication username */
username?: string;
username?: string | undefined;
/**

@@ -255,7 +255,7 @@ * Set viewport size if you have custom scrollbars or css attribute overflow to emulate window size

*/
viewportSize?: string;
viewportSize?: string | undefined;
/** Wait until window.status is equal to this string before rendering page */
windowStatus?: string;
windowStatus?: string | undefined;
/** Use this zoom factor (default 1) */
zoom?: number;
zoom?: number | undefined;

@@ -267,40 +267,40 @@ /*****************************

/** Centered footer text */
footerCenter?: string;
footerCenter?: string | undefined;
/** Set footer font name (default Arial) */
footerFontName?: string;
footerFontName?: string | undefined;
/** Set footer font size (default 12) */
footerFontSize?: number;
footerFontSize?: number | undefined;
/** Adds a html footer should be an URL */
footerHtml?: string;
footerHtml?: string | undefined;
/** Left aligned footer text */
footerLeft?: string;
footerLeft?: string | undefined;
/** Display line above the footer */
footerLine?: boolean;
footerLine?: boolean | undefined;
/** Do not display line above the footer (default) */
noFooterLine?: boolean;
noFooterLine?: boolean | undefined;
/** Right aligned footer text */
footerRight?: string;
footerRight?: string | undefined;
/** Spacing between footer and content in mm (default 0) */
footerSpacing?: number;
footerSpacing?: number | undefined;
/** Centered header text */
headerCenter?: string;
headerCenter?: string | undefined;
/** Set header font name (default Arial) */
headerFontName?: string;
headerFontName?: string | undefined;
/** Set header font size (default 12) */
headerFontSize?: number;
headerFontSize?: number | undefined;
/** Adds a html header should be an URL */
headerHtml?: string;
headerHtml?: string | undefined;
/** Left aligned header text */
headerLeft?: string;
headerLeft?: string | undefined;
/** Display line above the header */
headerLine?: boolean;
headerLine?: boolean | undefined;
/** Do not display line above the header (default) */
noHeaderLine?: boolean;
noHeaderLine?: boolean | undefined;
/** Right aligned header text */
headerRight?: string;
headerRight?: string | undefined;
/** Spacing between header and content in mm (default 0) */
headerSpacing?: number;
headerSpacing?: number | undefined;
/** Replace [name] with value in header and footer (repeatable) */
replace?: ReadonlyArray<[string, string]>;
replace?: ReadonlyArray<[string, string]> | undefined;

@@ -311,13 +311,13 @@ /***************

/** Do not use dotted lines in the toc */
disableDottedLines?: boolean;
disableDottedLines?: boolean | undefined;
/** The header text of the toc (default Table of Contents) */
tocHeaderText?: string;
tocHeaderText?: string | undefined;
/** For each level of headings in the toc indent by this length (default 1em) */
tocLevelIndentation?: string;
tocLevelIndentation?: string | undefined;
/** Do not link from toc to sections */
disableTocLinks?: boolean;
disableTocLinks?: boolean | undefined;
/** For each level of headings in the toc the font is scaled by this factor (default 0.8) */
tocTextSizeShrink?: number;
tocTextSizeShrink?: number | undefined;
/** Use the supplied xsl style sheet for printing the table of contents */
xslStyleSheet?: string;
xslStyleSheet?: string | undefined;

@@ -328,9 +328,9 @@ /**************************************

/** Cover object */
cover?: string;
cover?: string | undefined;
/** TOC object */
toc?: string;
toc?: string | undefined;
/** Page object */
page?: string;
page?: string | undefined;
}
export = wkhtmltopdf;
{
"name": "@types/wkhtmltopdf",
"version": "0.3.3",
"version": "0.3.4",
"description": "TypeScript definitions for wkhtmltopdf",
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/wkhtmltopdf",
"license": "MIT",

@@ -29,4 +30,4 @@ "contributors": [

},
"typesPublisherContentHash": "888ade79f5f2d39110bd715a8d161a05400db927d856bf99ac39eefc4202048e",
"typeScriptVersion": "3.3"
"typesPublisherContentHash": "5df7bb8cb7f1dbd51d27e2d7e189d144decbda6412e4d6fa709904f3351040dd",
"typeScriptVersion": "3.6"
}

@@ -11,3 +11,3 @@ # Installation

### Additional Details
* Last updated: Mon, 07 Dec 2020 13:22:01 GMT
* Last updated: Fri, 02 Jul 2021 18:05:42 GMT
* Dependencies: [@types/node](https://npmjs.com/package/@types/node)

@@ -14,0 +14,0 @@ * Global values: none

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc